Authentication API - NestJS + PostgreSQL

Table of Contents:

🎯 Objective
🏃 Running the project
📄 Scripts
📚 API Documentation
🚧 Troubleshooting

---

🎯 Objective

The main objective of this project is to create a simple authentication API to understand the use of JWT tokens, refresh tokens and role based authorization with Bearer Token Authentication strategy. It was built with NestJS and PostgreSQL.

For more details, check the 📚 API Documentation section.

Here you can find a Linkedin post explaining more about why to use Bearer Token with JWT in a Authentication System.

Functionality diagram

🏃 Running the project

You should have a Docker environment with support to Docker Compose V2.

⚠️ This project uses bash scripts to make some commands easier to run and was tested only on a Linux machine. If you are using Windows, I highly recommend you running this project inside a WSL2 distro, or using Git Bash as your terminal.

Open your terminal in the root folder and type:

sh ./scripts/run.sh

This script will make sure to build your images and in subsequent runs, it will skip the installation step and directly start all containers.

To stop running containers, just type:

sh ./scripts/stop.sh

and all your containers will be dropped and volumes will be removed.

📄 Scripts

Beyond run.sh and stop.sh, we have other helper scripts:

• run-db.sh: Run only database specific containers, when you want to run the application without Docker

📚 API Documentation

After running the server, an enteractive documetation with Swagger will be available at localhost:3000/docs

You can also execute a command to seed the database with users to use with API endpoints:

pnpm prisma db seed

⚠️ After that two users will be available for authentication:

• Admin User Email: [email protected]; Password: admin123
• Regular User Email: [email protected]; Password: user123

🚧 Troubleshooting

• Make sure you have these ports available before running the project:
  • 3000: Used by Nest API
• Make sure your Docker daemon is running!
• Make sure you are using a newer version of Docker that supports Docker Compose V2! This project does not use docker-compose (a.k.a. V1) because this version will no longer be supported from the end of June 2023.
• If you are somehow receiving Permission denied when trying to run any scripts, run

  chmod +x ./*.sh && chmod +x ./docker/*.sh

  to make sure your terminal can execute utility scripts.