A bookmark management API built with Nest JS and TypeScript. This study project is a dive into the best practices of Node JS back-end technologies. It leverages Docker and Docker Compose for containerized databases, employs Prisma as the ORM for streamlined database operations, and integrates JWT for secure authentication.

1. Clone the repository:

  git clone [email protected]:afonsofn/bookmarks-api.git && cd bookmarks-api

2. Install the dependencies:

  npm install

The project uses Prisma as an ORM and has convenience scripts to manage the database:

1. Start the dev database:

  npm run db:dev:start

2. Apply migrations to the dev database:

  npm run prisma:dev:deploy

3. Open Prisma Studio for the dev database:

  npm run prisma:dev:studio

Other useful scripts:

• Restart the development database:

  npm run db:dev:restart

• Delete the development database:

  npm run db:dev:delete

Similar scripts are available for the test environment, just replace dev with test in the commands above.

• Start API in dev mode:

  npm run start

• Start API in dev watch mode :

  npm run start:dev

• Start API in prod mode :

  npm run start:prod

• Run end-to-end tests:

  npm run test:e2e

• Format the code with Prettier:

  npm run format

• Run ESLint:

  npm run lint

This project is distributed under the MIT license.

Developed by @Raff