CoopCycle

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.To run docker, you need Windows Pro or Windows Enterprise, it's not running on Windows Home. Once installed, you need to share the drive where your code is (https://blogs.msdn.microsoft.com/stevelasker/2016/06/14/configuring-docker-for-windows-volumes/). You need to download wget and openssl. http://gnuwin32.sourceforge.net/packages/wget.htm http://gnuwin32.sourceforge.net/packages/openssl.htm The make script suppose that both are found under "C:\Program Files (x86)\GnuWin32\bin". If there are at a different place, change the windows_make.cmd script accordingly.

  • 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).

• Get a Google Map API Key and copy it. You will be asked for it when running make install.

• Create a Stripe account and copy your tests credentials. You will be asked for them when running make install.

• Run the install scripts - when asked for app/config/parameters.yml parameters please enter your Google (google_api_key) and Stripe test (stripe_secret_key and stripe_publishable_key) credentials, for others you can keep defaults.

make install

-On Windows: run windows_make.cmd from a command prompt (CMD) with administrator rights.

Run the application

• Start the Docker containers

docker-compose up

• 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 change. To take account for 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