Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Getting Started

Houjun Liu edited this page Dec 9, 2022 · 9 revisions

Getting Started with Debug

We assume that you have a copy of Docker installed. If not, do that.

Secrets

After following the instructions to get secret provisioning (see the README), install git-secret. Ensure that the key you shared with us for the secrets is installed on your development machine.

Then, execute:

git secret reveal

to automatically reveal all of the needed secrets.

Database initialization

In the repository, run:

make init

to run initial system tests and set up all containers + development databases.

Daily use

We use make to orchestrate on all of the tasks you work on in this module.

  1. to start development services make start
  2. to restart development services make restart
  3. to run the test suite make test
  4. to drop into a shell? make backendshell and make frontendshell

Epic! localhost:8080 and localhost:8082 should be the endpoints of frontend/backend respectively. If the instructions are followed correctly, Docker should be entirely transparent; just edit code in your local machine, and it will sync into containers and pull a fast-refresh of both endpoints automatically. If you want to see the logs, visit the logs section in the Docker app or use docker compose log.

Clone this wiki locally