ProjectRun API

About:

This is ProjectRun API built with Node.js (Nest.js).

Requirements:

• Node.js v18.* or higher
• npm v9.* or higher
• Docker v20.* or higher
• Docker Compose v2.* or higher

Installation:

• Install the project and dependencies:

git clone git@gitlab.com:projectrun/projectrun-api.git
cd projectrun-api/ && npm install

• Create .env file and fill the environment variables.

• Custom command to:

  1. remove db_service container: docker-compose rm -f -s -v db_service
  2. run the db_service container: docker-compose up -d db_service
  3. apply migrations: npx prisma migrate deploy
  4. run the seeders: ts-node prisma/seed.ts (custom command)

npm run db:restart

• Run the server:

# development
npm run start:dev
# production
npm run start

• "forever" commands:

# start
forever start -c "npm run start" ./
# list
forever list
# stop
forever stop <pid>

• [Optional] Sometimes the port is not released after stopping the server. To fix this:

# find and kill the process that uses the port
kill -9 $(lsof -t -i:3010)

• Browse db via browser's default host on development mode:

npx prisma studio

• [Development] Reset the database:

npx prisma migrate dev (-y)
npx prisma db push
npm run db:restart

Resources:

• Live dev-server API gateway
• Mobile app wireframe paper screens at Figma
• Mobile app wireframe animation video on YouTube
• GitLab group
• Trello board
• Postman workspace

Technologies used:

• Nest.js
• Prisma
• PostgreSQL
• Docker
• Docker Compose
• JWT
• argon2

Authors:

• BoolFalse