- For Mac users:
- Install Homebrew if you haven't already.
brew install dockerbrew install docker-composebrew install node- Navigate to the root of this project directory and run
./scripts/setup.sh
- For windows users:
- Go to https://docs.docker.com/docker-for-windows/install/ to install Docker.
- Go to https://docs.docker.com/compose/install/#install-compose to install Docker Compose.
- Go to https://nodejs.org/en/download/ to install node.js
- Navigate to the root of this project directory and run
./scripts/setup.sh
Preferred IDE: VS Code
This workflow is for if you want to run the entire application using Docker.
- Navigate to the project directory
- Make sure your Docker Daemon is running. For Mac, you'll see the whale icon on the top right corner which is the daemon, so make sure that is running.
- Run
docker-compose up --buildwhen you've made changes to the code. Or omit the--buildflag if you have made no changes. - Go to http://localhost:3000/
It is often slow to do front-end development in a Docker container and wait for code to build. If you are only working on the frontend, run only the backend services through docker-compose, and run the frontend locally.
- Comment out the
clientconfigs indocker-compose.yml. cd clientnpm install(do this only the first time or if you changeclient/package.json)npm start