Skip to content

Latest commit

 

History

History
82 lines (62 loc) · 2.13 KB

README.md

File metadata and controls

82 lines (62 loc) · 2.13 KB
Raw

Bookmark API utilizing NestJs

Built with ❤︎

💻 Technologies

This project was made using the follow technologies:

  • [Javascript]
  • [Nest.Js]
  • [Prisma]
  • [PostgresSQL]
  • [Docker]
  • [OpenAPI:Swagger]
  • [Jest]

💬 Description

  • A bookmark API developed with NestJS, integrating authorization and JWT for authentication, employing Docker and PostgreSQL. It features Jest for end-to-end testing and implements Swagger for documentation.

🚀 Features

  • Key features include: 15 test cases, 2 models, an automated testing script, automated development database migration, and Swagger documentation.

👷 How to run the server

# Clone Repository
$ git clone https://github.com/hx-gh/nestjs-bookmark-api.git

💻 Run Server

# Go to web folder
$ cd nestjs-bookmark-api
# Install Dependencies
$ npm install
# Run Aplication
$ npm run start:dev

💻 Run Database

# Run Database
$ npm run db:dev:restart

💻 Run Prisma Studio

# Run Database
$ npx prisma studio

💻 Run Tests Suit

# Run Database
$ npm run test:e2e

📕 License

Released in 2024

Give a ⭐️ if this project helped you!