EpiJavascript - back

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Running the app
  • Environment variable
• Deployment
• Documentation
• Migrations
• License
• Contact

About The Project

Recration of a discord web application.

Api of the front project.

Built With

• Nest.js

Getting Started

Prerequisites

• Node v.14.17.5 (lts/fermium)
• Yarn or Npm according to the Node version

Installation

yarn

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Environment variable

The app loads a dotenv file depending on your NODE_ENV environment variable (fallback to development) : .env.$NODE_ENV.

If a local dotenv file is provided, the app will load it instead : .env.$NODE_ENV.local.

Deployment

This project is link with multiple Heroku applications, pushing to some branches will trigger an auto-deployment :

• dev -> https://dashboard.heroku.com/apps/epi-javascript-backend-dev
• maaster -> https://dashboard.heroku.com/apps/epi-javascript-backend-prod

Documentation

The code is documented using a Swagger that you can browse at the /swagger endpoint

Migrations

See migrations README

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/EpiJavascript/back