who-herams
Set up developer environment
Requirements
- Git must be available
Steps
- Get Docker
- Get Docker Compose
- Run the following commands:
git clone git@github.com:WorldHealthOrganization/herams-backend.git
cd herams-backend
cp .env.default .env
- Optionally alter
.env
to suit your preferences, it is recommended to set UID and GID to prevent permission issues - Run
docker-compose up serve
Result
After taking the above steps you will have everything up and running:
- A database with username
root
and passwordsecret
, and a user / password / database combo from your.env
file. - An application with (invalid) email:
root
and password:secret
- A mailcatcher allowing you to inspect mails sent by the system
Commands available
We expose a number of commands via docker-compose:
docker-compose run --rm composer
will run composer, use this to install / update dependencies.docker-composer run --rm codeception
will run the test suite