sofiane/covibundle

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (dev-master) of this package.

dev-master 2018-10-01 09:24 UTC

Requires

• kahlan/kahlan: *

Unknown License

README

ABout CoviRide

Interface which displays carpools available on a territory and allows connection between carpoolers making the same trip daily or punctually.

Requirements

• PHP: =>7.1
• Composer =>1.7

• Node.js => 10

• for Windows check the windows requirement part

Install

• Clone the repo

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

cd CoviRide

• Install symfony dependencies & npm dependencies composer install && npm install

-Build assets files npm run compile

-Download tools for dev npm run postinstall

Tests

We use Kahlan to create unit/functionnals tests, you cna launch them easily with:

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

Or just:

npm test On unix systems

Start

To start the application simply enter :

npm start

& just go http://localhost:8000

Developpement

To contribute to the Coviride application, please do the following:

1. Create a branch by feature or fork the repo if you are not in dev team
2. Start the dev tools (necesary to watch js/css/sass): npm run compileAndWatch
3. Add some Unit Tests and/or functionnals test and check if build passed
4. Create a pull request & set reviewver before merge

Javascript/Vue-js

The main library for javascript used is vue-js, everything about them are in components

We use webpack-encore with babel, if you need to use some new fun stuf in js you can check stage(babel 6 part) install & require the right plugin in webpack config

💄 We use esLint rules to check code linting,if some rules are too restricted you can disable them or make the warning only in .eslintrc.json

For some mistakes as bad indent, spaces .. a fix is automaticaly applied !

Bulma/buefy

We use buefy which is a vue adaptation of bulma as a front-end scss framework, you can:

• Check the buefy doc to find elements you want to use, such as modal, layou ..
• Change any default bulma variables in variable.scss such as mobile variables
• Use bulma variable inside vue-js components as in the parrot sample

Mapbox

We are using Mapbox-glue for route information & calcs, please check mapbox-gl api

Documentation

A developer doc is available here (it is generated automatically afetr each release), in order to generate the doc just do: npm run generateDoc

Database

You will find a documentation about the database here

Contribute Guideline

Please check:

• JS GuideLine
• Symfony GuideLine

and contributor covenant

Licence

AGPL-3

Windows Requirements

Please use powershell with our project, in requirement you will need:

BE SURE TO BE IN AN ADMIN CONSOLE MOD !

• Install windows package managerchocolatey
• Restart powershell
• Install php: choco install php
• Install composer: choco install composer
• Install nodejs: choco install nodejs.install
• Install python3: choco install python
• Install python2: choco install python2
• Install wget: choco install wget
• Install windows dev tools: npm install --global --production windows-build-tools
• ... then you can follow the install section