GithubHelp home page GithubHelp logo

blockcoders / nestjs-api-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
5.0 3.0 0.0 360 KB

A boilerplate for building production-ready RESTful APIs using NestJS

JavaScript 15.53% Dockerfile 24.84% TypeScript 59.63%
nodejs boilerplate express fastify nest nestjs-backend nestjs nestjs-boilerplate rest-api starter

nestjs-api-boilerplate's Introduction

NestJS Api Boilerplate

REST API NestJS Quick Start

Environment setup

  • Install Node.js
    • Recommended method is by using NVM
    • Recommended Node.js version is v16.13
  • Install Docker

Get Started

Install all the dependencies:

pnpm i --frozen-lockfile

Copy the .env.sample file to .env

cp .env.sample .env

In the project directory, you can run:

pnpm start:dev

Runs the NodeJs services in the development mode.
Open localhost:8080/api/v1/ping to view it in the browser or Postman.

The service will reload if you make edits.

Test

pnpm test

Running the unit tests.

pnpm test:cov

Running the test coverage.

nestjs-api-boilerplate's People

Contributors

0xslipk avatar

Stargazers

avatar avatar avatar avatar avatar

Watchers

avatar avatar 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.