Skip to content

rsc1102/nestjs-wish-list-api

Repository files navigation

Wish List API

TypeScript badge NestJS badge PostgreSQL badge Yarn badge Jest badge Docker badge Prisma badge PactumJS badge Passport badge

This is a Wish list API built using NestJS, designed to help users create and manage their personal wish lists.

Features

  • User Authentication: Secure sign-up and sign-in using JWT.
  • Wish list Management: Users can add, edit, and delete items on their wishlist.
  • Social Connectivity: Users can send friend requests, accept them, and become friends to view each other's wishlists. (This feature is still in development)

Prerequisites

  • Node.js
  • TypeScript
  • Yarn
  • Docker

Clone

Clone the repository. Create two files in the repo directory:

.env

DATABASE_URL="postgresql://postgres:123@localhost:5434/nest?schema=public"
JWT_SECRET="secret"

.env.test

DATABASE_URL="postgresql://postgres:123@localhost:5435/nest?schema=public"
JWT_SECRET='super-secret'

Run

Setup PostgreSQL using the following command:

yarn db:dev:restart

Run the app using:

# Run in development mode
yarn start

# Run in watch mode (development)
yarn start:dev

Tests

# Run tests end to end
yarn test:e2e

Contributing

If you have suggestions for improvements or bug fixes, please feel free to fork the repository and submit a pull request.