Description

Training application made with NestJS, Prisma and PostgresSQL.

Project includes

• User registration and authentication managed with JWT strategy
  • Email and password
  • Google OAuth
  • Github OAuth
• User profile management
• User roles and permissions
• Subscription management
• Post creation and management

Installation

Install all dependencies

yarn install

Environment variables

Create a .env file in the root of the project and add the following variables:

Google OAuth
GitHub OAuth

If you want to use the default DB settings, you can use DATABASE_URL that is commented out.

DATABASE_URL="postgresql://postgres:{your-db-password}@localhost:{db-port}/{db-name}?schema=public"
#DATABASE_URL="postgresql://postgres:123@localhost:5434/photos4you?schema=public"
JWT_SECRET="your-secret"
REFRESH_JWT_SECRET="your-secret-rt"
GOOGLE_CLIENT_SECRET="chnage-me"
GOOGLE_CLIENT_ID="chnage-me"
GOOGLE_CALLBACK_URL="chnage-me"
GITHUB_CLIENT_ID="chnage-me"
GITHUB_CLIENT_SECRET="chnage-me"
GITHUB_CALLBACK_URL="chnage-me"

Database setup

When setting up the DB for the first time

prisma migrate dev --name {migration name}

Run Database in docker

Run DB in docker container, if you are running DB with custom credentials, make sure to update the docker-compose.yml to math your settings in .env.

# run DB in background
docker compose up -d dev-db

# run DB in terminal
docker compose up dev-db

Running the app

# development
yarn run start

# watch mode
yarn run start:dev

# production mode
yarn run start:prod

Running application in kubernetes cluster

Required for metrics and monitoring

Requirements

• Docker Desktop (Windows)
  • Enable Kubernetes in Docker Desktop settings
• kubectl
• hilt
• ngrok

# install all dependencies for metrics and monitoring
helm dependecy update

# install helm chart
helm install nestjs-metrics .

Access grafana dashboard

kubectl get svc

Look for port(s) for nestjs-metrics-grafana 80:xxxxx/tcp

Grafana is accessible at http://localhost:xxxxx

Credentials:

• username: admin
• Password is encoded in secret, to decode it run the following command

$secret = kubectl get secret nestjs-metrics-grafana -o jsonpath="{.data.admin-password}"
[System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($secret))

Add datasource to Grafana

• URL: http://nestjs-metrics-prometheus-server:80

Forward port to access API endpoints

# we will use 3112 port to access kube API endpoints, and leave 3111 for development
kubectl port-forward pod/nestjs-metrics-745946b46-hb8m6 3112:3111

Ngrok to expose local db server to the internet

# ngrok account needed, payment method for tcp tunneling required
ngrok tcp 5434

Update environment variables in kubernetes deployment

kubectl set env deployment nestjs-metrics DATABASE_URL="postgresql://postgres:123@{ngrok forwarding address}/photos4you" 

• API base url http://localhost:3112
• Grafana http://localhost:xxxxx
• DB base url tcp://x.tcp.ngrok.io:xxxxx