Skip to content

An application for users to search for books and save them in custom lists. Using Nest.js for the backend, and postgreSQL database

License

Notifications You must be signed in to change notification settings

misalima/book-finder-backend

Repository files navigation

Book Finder

Description

This is the backend of the application Book Finder, built with Nest.js.

Installation

Before running the application, you need to install its dependencies:

$ npm install

Getting Started

Prerequisites

Make sure you have the following tools installed on your machine:

Environment Variables

Before running the application, copy the .env.example file to a new .env file in the project root:

$ cp .env.example .env

Running the Database

Before running the Nest.js application, you need to start the PostgreSQL database using Docker Compose. Make sure you have Docker running, and run:

$ docker-compose up

Prisma Commands

We are using Prisma ORM, so if it's the first time you're running the application, you will need to run Prisma commands to set up the database schema and apply migrations. Here are the common commands:

# install Prisma
$ npm install prisma@latest @prisma/client

# apply database migrations
$ npx prisma migrate dev

# generate Prisma client
$ npx prisma generate

Running the app

The server should be on port 3333 after you run one of the following commands:

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

Book Finder is MIT licensed.

About

An application for users to search for books and save them in custom lists. Using Nest.js for the backend, and postgreSQL database

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published