Skip to content

Latest commit

 

History

History
executable file
·
120 lines (81 loc) · 4.23 KB

README.md

File metadata and controls

executable file
·
120 lines (81 loc) · 4.23 KB
Raw

CoopCycle

Build Status

CoopCycle is a self-hosted platform to order meals in your neighborhood and get them delivered by bike couriers. The only difference with proprietary platforms as Deliveroo or UberEats is that this software is reserved to co-ops.

The main idea is to decentralize this kind of service and to allow couriers to own the platform they are working for. In each city, couriers are encouraged to organize into co-ops, and to run their very own version of the software.

The software is under active development. If you would like to contribute we will be happy to hear from you! All instructions are in the Contribute file.

Coopcycle-web is the main repo, containing the web API, the front-end for the website and the dispatch algorithm :  Technical Overview . You can see it in action & test it here : https://demo.coopcycle.org

You can find a comprehensive list of our repos here : Our repos comprehensive list .

How to run a local instance

Prerequisites

  • Install Docker and Docker Compose.

    • On OSX : use Docker for Mac which will provide you both docker and docker-compose. It doesn't rely on Virtualbox as Docker used to.

    • On Windows : use Docker for Windows which will provide you both docker and docker-compose. It doesn't rely on Virtualbox as Docker used to.

    • On Linux : follow the instructions for your distribution. docker-compose binary is to be installed independently. You can use CoopCycle without root privileges, to do so run sudo usermod -aG docker your-user (will add you to the docker group).

  • Setup Google Maps API

CoopCycle uses the Google Maps API for Geocoding, as well as the Places API. You will need to create a project in the Google Cloud Platform Console, and enable the Google Maps API. GCP will give you an API token that you will need later. By default, the Geocoding and Places API will not be enabled, so you need to enable them as well (Maps API dashboard > APIs > Geocoding API > Enable, and Maps API dashboard > APIs > Places API for Web > Enable).

  • (Linux) Setup permissions

If you are using Linux, you will need to allow the user www-data used by the php docker container to write files to your local disk. You can do this by running the following commands in the directory containing your local clone of the repository:

sudo chown -R $(id -u):82 coopcycle-web
sudo chmod -R g+w coopcycle-web
  • Run the install scripts.
make install

Run the application

  • Start the Docker containers
docker-compose up
  • Or if needed with an additional UI to help you manage the containers environment

Use the below command to get the portainer UI:

docker-compose -f docker-compose.yml -f docker-compose-portainer.yml up

open http://localhost:9000 to access portainer Setup and confirm the admin password the first time you use it.

  • Open the platform in your browser
open http://localhost

Testing

  • Create the test database
docker-compose run php bin/console doctrine:schema:create --env=test
  • Launch the PHPUnit tests
make phpunit
  • Launch the Behat tests
make behat
  • Launch the Mocha tests
make mocha

Running migrations

When pulling change from the remote, the database models may have changed. To apply the changes, you will need to run a database migration.

make migrations-migrate

License

The code is licensed under the Peer Production License, meaning you can use this software provided:

  • You are a worker-owned business or worker-owned collective
  • All financial gain, surplus, profits and benefits produced by the business or collective are distributed among the worker-owners