/bookmark-api

NestJs is a scalable NodeJs framework in typescript . This a capestone project API i used while learning Nest js from youtube channel FreeCodeCamp

Primary LanguageTypeScript

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

Nest framework TypeScript starter repository.

Bookmark API

The Bookmark API is a RESTful API that allows users to manage bookmarks. It provides endpoints for creating, retrieving, updating, and deleting bookmarks, as well as user authentication and authorization.

Features

  • User authentication: Users can sign up, sign in, and obtain access tokens for authentication.
  • Bookmark management: Users can create, retrieve, update, and delete bookmarks.
  • User management: Users can retrieve their own user profile and update their user information.

Technologies Used

  • Nest.js: A progressive Node.js framework for building efficient and scalable server-side applications.
  • Prisma: A modern database toolkit for Node.js and TypeScript.
  • PostgreSQL: A powerful, open-source relational database management system.
  • JWT: JSON Web Tokens for secure authentication and authorization.
  • Jest: A JavaScript testing framework for writing unit and integration tests.
  • Docker: A containerization platform for building, deploying, and running applications.

Installation

  1. Clone the repository:

    git clone https://github.com/ankitrout2903/bookmark-api.git
    
    

Installation

$ yarn install

Running the app

Install Docker desktop before running api https://www.docker.com/products/docker-desktop/

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov
yarn // install
yarn db:dev:restart // start postgres in docker and push migrations
yarn start:dev // start api in dev mode