Setup

Dev Container Setup

Prerequisites: Docker and Dev Containers Extension.

1. Clone and open the repository locally in VS Code (or any other IDE that supports Dev Containers).

2. Click on the Reopen in Container button that pops up in the bottom left corner of the VS Code window.

   • Or open the command palette and run the command Dev Containers: Reopen in Container.

3. Wait for the container to start. It may take a few minutes to install dependencies and run post create script.

4. Install recommended extensions. You can view them by opening the command palette and run the command Extensions: Show Recommended Extensions.

5. Visit the respective README files to start developing!

   • Web: apps/web/README.md
   • Visualizer: apps/visualizer/README.md
   • Server: apps/server/README.md
   • Data: apps/dataflow/README.md
   • Scripts: scripts/README.md

Troubleshooting

Git submodule

git submodule update --init --recursive --remote

If you want to clone with https instead of ssh, see this Stack Overflow post.

Dev Container Installation Issues

Check if the Docker Desktop version is up to date.

Post Create Script Failure

If the post create command in dev container fails, you can manually run the post create script in the container by running the following command in the root directory:

./.devcontainer/post-create.sh

Port in Use Error

If you see errors about 'port in use', use lsof -i :5432 to find the process using that port and kill it with kill -9 <PID>.

Script Setup

Prerequisites: Docker and Homebrew.

1. docker compose -f .devcontainer/docker-compose.yml up -d

   • The ports forwarding needs to be defined

   • Environment variables such as DATABASE_URL needs to be changed.

     • DATABASE_URL="postgresql://postgres:donotuseinprod@localhost:5432/cmumaps" ?

2. Run .devcontainer/post-create.sh

3. Install recommended extensions. You can view them by opening the command palette and run the command Extensions: Show Recommended Extensions.