Development Environment

Setup prerequisites

You should install the following prerequisites:

For more details, please reference to backend's dockerfile. There is a full dependence packages installation guideline.

ENV=dev make init
# Add ENV=dev to .env
# Update config/app.yaml
make db # Start databases

Frontend code is located in ./web/ folder.

Requirements:

To install nodejs, see nodejs.org To install pnpm, see pnpm.io

Start the frontend:

make ui

Backend code is located in ./ (root) folder.

Requirements:

To install backend dependencies, run the following commands:

make run

# setup air for hot reloading
go install github.com/cosmtrek/air@latest

# run backend
make run-air
# OR, to run manually
# air   

To setup MongoDB locally for developing backend, run the following commands:

ENV=dev make init
# Update .env file
make db

Then, to execute commands in the container, run the following commands:

make exec-mongodb # Run with normal user
make exec-mongodb-root # Run with root user

To develop documentation, run the following commands:

make docs

Documentation is in ./docs/ folder.

To generate API documentation, run the following commands:

make build/api-docs

OR, to run manually:

# Generate swagger documentation
swag init
# Format swagger code comments
swag fmt

Running the command below will build and release the project to github release page.

goreleaser release --clean

make release

To test the release locally, run the following command:

goreleaser release --clean --snapshot