Project Overview

This project is a backend API built with NestJS that provides:

• User Authentication using JWT with login, logout, and registration.
• Blog CRUD operations to create, read, update, and delete blog posts.
• Unit Testing with Jest to ensure code quality and reliability.

Project setup

$ npm install

create database as blog in mysql
change mysql credentials (such as host, port,username, password, and database)

## Compile and run the project

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Features

Authentication

• Register a new user with hashed password storage.
• Login with username and password, returning a JWT token.
• Logout support by token blacklist (demo implementation).
• JWT-based authorization for protected routes.

Blog Management

• Create new blog posts.
• Retrieve all or single blog posts.
• Update existing blog posts.
• Delete blog posts.

Testing

• Unit tests for services and controllers.
• Mock dependencies for isolated tests.
• Test coverage for authentication and blog features.

---

Tech Stack

• NestJS - Node.js framework
• TypeScript
• JWT - JSON Web Token for auth
• bcryptjs - Password hashing
• Jest - Testing framework

---

Getting Started

Prerequisites

• Node.js >= 16
• npm or yarn
• A database (e.g., PostgreSQL, MySQL) and its connection configured (if used)

Installation

git clone <your-repo-url>
cd <project-folder>
npm install
# or
yarn install

Running the App

npm run start:dev
# or
yarn start:dev

The server will run on http://localhost:3000 by default.

---

API Endpoints

Auth

• POST /auth/register - Register a new user
• POST /auth/login - Login and receive JWT token
• POST /auth/logout - Logout user (token blacklist)

Blog

• GET /blogs - Get all blogs
• GET /blogs/:id - Get blog by ID
• POST /blogs - Create new blog (protected)
• PATCH /blogs/:id - Update blog (protected)
• DELETE /blogs/:id - Delete blog (protected)

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g @nestjs/mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.