GrapeoffJS / CRMServer

1 stars 1 forks source link

Nest Logo

This Server Based on NestJS

<p align="center">

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

CRM System REST API server.

Installation

$ npm i -g @nestjs/cli typescript
$ yarn install

Running the app

# development
$ yarn start:dev

# production mode
$ yarn build
$ yarn start:prod

Generating documentation

$ yarn doc

Then open http://localhost:8080 in your browser.

API Documentation

If you need API Documentation, do these following steps:

  1. Start the application
    $ yarn start
  2. Open http://localhost:4200/api/docs in your browser.

Deployment

$ docker compose up --build -d

It requires at least 16GB RAM.

License

Nest is MIT licensed.