Skip to content

A simple RESTful API for managing a Recipes list, built with Nest.js for learning and experimentation.

Notifications You must be signed in to change notification settings

auri-gabriel/recipes-api

Repository files navigation

Description

A RESTful API for managing recipes, built with NestJS and Prisma.

Project Setup

  1. Install dependencies

    npm install
  2. Set up environment variables

    Copy the example environment file and adjust values as needed:

    cp .env.example .env
  3. Start required services with Docker Compose

    This will start the database and any other required services in the background:

    docker compose up -d
  4. Generate Prisma client

    npx prisma generate
  5. Apply database schema

    Push the Prisma schema to your database:

    npx prisma db push

Running the Project

  • Development mode

    npm run start
  • Watch mode (auto-reload on changes)

    npm run start:dev
  • Production mode

    npm run start:prod

Once running, access the Swagger API documentation at: http://localhost:3000/api

Testing

  • Unit tests

    npm run test
  • End-to-end (e2e) tests

    npm run test:e2e
  • Test coverage

    npm run test:cov

About

A simple RESTful API for managing a Recipes list, built with Nest.js for learning and experimentation.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published