api.bookstore.nas

Description

API Server built using , TypeScript, Prisma, Graphql and PostgreSQL.

Built with ❤️on top of

• Typescript
• NestJS
• Prisma
• Passport.js
• Graphql:Schema First
• PostgreSQL

Functional specs

API allows authenticated to users to create and manage orders

• User SignUp & SignIn
• CRUD Orders
• Inspect Items

Technical methodologies followed

• Modular architecture: Business Logic & Auth handled in separate modules, separating concerns.
• HTTP requests are handled by Controllers
• API documentation using nest/swagger module
• Business logic is implemented in Services
• Database interactions are handled using Prisma
• Validation using NestJS Pipes
• Data Transfer Object(DTO) pattern for transferring data between layers
• Configuration management using .env files for development, test & prod configs
• Authentication / Authorization, Event ownership by users
• PassportJS, JWT tokens, Password hashing, salts
• Unit tests using Jest
• Supertest for E2E testing

Technical documentation using Compodoc

As NestJS is heavily inspired by Angular, we can generate the documentation about project structure modules, controllers, services etc. I have generated the docs.

Find 'em here - https://jsFame.github.io/api.bookstore.nas/

Installation

npm install -g pnpm
pnpm install

Running the app

Prerequisite for running the app in any mode - dev/test/prod

• Copy .env.example with .env
• Fill in the env vars in .env

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

License

This repo is MIT licensed.