Code Monkey home page Code Monkey logo

nestapi's Introduction

NestJs Logo

Node Version NPM Version code style: prettier CodeFactor Code Coverage Build License Stars

DescriptionStackInstallationDatabaseEntity Relationship DiagramRunning the appEndpointsTestVideo TutorialsHelpful reposNode best practicesLicense

Description

A dockerized boilerplate Node.js API using NestJS and Typescript that includes Authentication, Input validation, Error handling, Logging, API versioning and Pagination.

Stack

Language Typescript
Framework NestJS
Database Postgres
ORM Prisma
E2E Testing Jest & Pactum
Load Testing k6
Documentation Swagger
Linter Prettier
CI Github Actions

Installation

$ npm install

Database

# Start postgres container and push migrations
$ npm run db:dev:restart

# Generate migrations
$ npm run prisma:dev:migrate

# Seed data
$ npx prisma db seed

# View data
$ npx prisma studio

Entity Relationship Diagram

Entity Relationship Diagram

Running the app

# Development
$ npm run start

# Watch mode
$ npm run start:dev

# Production
$ npm run start:prod

Endpoints

# API
http://localhost:8080

# Swagger
http://localhost:8080/api

# Grafana
http://localhost:3000/d/k6/k6-load-testing-results

Test

# Run e2e tests
$ npm run test

# Run tests with coverage
$ npm run test:cov

# Run load tests
$ npm run test:load
Coverage Report Load Report

Video Tutorials

Helpful repos

Node best practices

License

This project is licensed under the MIT License - see the LICENSE file for details.

nestapi's People

Contributors

pedrocorreia105 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.