localdev.md

Local Development

When doing local development, you can run this stack in the background and edit files in the /backend and /frontend directories and the environment with automatically update.

The listening port for the web frontend defaults to http://localhost:5150, The backend is exposed via http://localhost:4000 by default.

These values can be adjusted by editing the localdev env file .env

---

IMPORTANT

It's suggested you work in branch local when developing Pushing / merging PR's to any branches with a prefix of aws/ will trigger deployment actions

---

Operating System Requirements

• Linux
• MacOS (testing)
• Windows using WSL2
  • WSL Integration on Ubuntu must be enabled in Docker options -> Resources -> WSL Integration
  • Repo must be inside Ubuntu (i.e. ~/code/trash-ai)
  • Make local must be run from a WSL (Ubuntu) terminal
  • Take note of docker-compose installation (installing through apt may not install the correct version)

Software Requirements

• docker ce
  • ubuntu/debian: https://docs.docker.com/engine/install/ubuntu/
  • mac: https://docs.docker.com/desktop/mac/install/
• docker-compose Instructions
  • Docker-compose file version >3.7 are supported
  • For MacOS, use docker-compose version 1.x

   $ docker-compose disable-v2

---

Optional Software

• gnu make
  • ubuntu/debian: apt-get install build-essential
  • mac: brew install make

Running the dev environment

Using make in project root:

make local

---

Using the shell:

cd localdev
# need to make sure the containers are down before starting
docker-compose down
docker-compose up --remove-orphans --build
# down stack
docker-compose down