README

关于 CoviRide

接口显示在领土上可用的拼车，并允许进行日常或偶发性旅行的拼车者之间建立连接。

要求

• PHP: =>7.1
• Composer =>1.7

• Node.js => 10

• 对于 Windows，请检查Windows 要求部分

安装

• 克隆仓库

git clone https://gitlab.com/covivo/CoviRide

cd CoviRide

• 安装 symfony 依赖项和 npm 依赖项 composer install && npm install

-构建资源文件 npm run compile

-下载开发工具 npm run postinstall

测试

我们使用 Kahlan 创建单元/功能测试，您可以使用以下命令轻松启动它们

vendor\bin\kahlan --cc=true --reporter=verbose 用于 cmd/powershell

或者在 Unix 系统上

npm test

启动

要启动应用程序，只需输入

npm start

& 直接访问 https://:8000

开发

要为 Coviride 应用程序做出贡献，请执行以下操作

1. 通过功能创建分支或如果您不在开发团队中，则分支仓库
2. 启动开发工具（必需以监视 js/css/sass）：npm run compileAndWatch
3. 添加一些单元测试和/或功能测试，并检查构建是否通过
4. 创建拉取请求并设置审查者，然后合并

JavaScript/Vue-js

用于 JavaScript 的主要库是 vue-js，有关它们的所有信息都在 components 中

我们使用 webpack-encore 与 babel，如果您需要在 JavaScript 中使用一些新功能，您可以在 阶段（babel 6 部分）安装并要求在 webpack 配置 中安装正确的插件

💄 我们使用 esLint 规则 检查代码格式，如果某些规则过于严格，您可以在 .eslintrc.json 中禁用它们或仅将其设置为警告

对于一些错误，例如错误的缩进、空格等，将自动应用修复！

Bulma/buefy

我们使用 buefy，它是 bulma 的 Vue 版本，作为前端 scss 框架，您可以

• 检查 buefy 文档 以找到您想要使用的元素，例如 modal、layou ..
• 在 variable.scss 中更改任何默认 bulma 变量，例如 移动变量
• 在 Vue-js 组件中使用 bulma 变量，如 parrot 示例

Mapbox

我们使用 Mapbox-glue 用于路线信息和计算，请检查 mapbox-gl api

文档

开发者文档可在此处找到（它会在每次发布后自动生成），要生成文档，请执行：npm run generateDoc

数据库

您可以在此处找到有关数据库的文档

贡献指南

请查看

• JavaScript 指南
• Symfony 指南

以及贡献公约

许可证

AGPL-3

Windows 系统要求

请使用 PowerShell 与我们的项目一起使用，在要求中您将需要

务必在管理员控制台模式下！

• 安装 Windows 软件包管理器chocolatey
• 重启 PowerShell
• 安装 PHP：choco install php
• 安装 Composer：choco install composer
• 安装 Node.js：choco install nodejs.install
• 安装 Python3：choco install python
• 安装 Python2：choco install python2
• 安装 wget：choco install wget
• 安装 Windows 开发工具：npm install --global --production windows-build-tools
• 然后您可以按照安装部分的说明进行操作