Periodum API

Periodum project's backend.

Tech Stack

• NodeJS: v16.13.2 (includes npm v8.1.2) with TypeScript
• MongoDB: v5.0
• Latest Docker Engine with Docker-Compose

Development

Run localy

After you have required tech stack above, feel free to run it like this.

npm install && \
npm run dev

Run inside Docker

# Run the db in background
docker-compose --env-file ./dev.env up -d db

# Run the app in foreground
docker-compose --env-file ./dev.env up app --build

# Run the app in background
docker-compose --env-file ./dev.env up -d app --build

Some tips

• --build arg is required when you need to install new package unless you install inside the container.

• You can connect to the running container via VSCode without installing NodeJS or any other dependencies on your machine. Just attach to the Periodum API container after running the container.

Contribution Guidelines

Please follow the same guidelines with the main project.