How to contribute

Set up local development

Requirements

• Install and run Docker

Windows (VS code)

• Install extension Dev Container.
• In VSCode Command Palete (Ctr + Shift + P), type and select Dev Container: Reopen in Container.
• The container will take few minutes to run up. After the develop container is up the VSCode is ready, open the terminal.
• Run commands:

make install
make packages
make frontend
make backend
make start

• The web app should be accessible at localhost:3000/

Development procedure

• make help to see the list of comands
• Frontend: If you make changes in frontend, just need to run make frontend then refresh the web app.
• Backend: If you make changes in backend, Ctr + C to stop the server then make backend to rebuild and make start to start server again. I'll try to find a way to speed up by having auto watch and quick recompilation later.
• For shared packages in packages folder: make packages

Deployment image

Build

# On root directory

$ docker-compose build apps

or 

$ docker build .

Start

Make sure development container is down since they have port conflicts 3000

$ docker-compose up apps