/mundo-api

MUNDO back-end conference logistics data access API

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

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

Description

Nest framework TypeScript starter repository.

Installation

Setup:

# Install dependencies
$ npm install
$ npm install -g @nestjs/cli

# Create local dotenv file
$ cp .env.sample .env  # Once created, modify values as needed.

You should only have to modify the value for PROD_PG_HOST and PG_PASSWORD before cloning the remote db. You must have Docker installed to run this script.

# Dump remote database and restore to a local Postgres image.
$ sudo ./data/run-local-db.sh

If you go this route, use the output IP in nexus-postgres-local RUNNING ON <IP> as your PG_HOST

If you do not have credentials for the remote db, create a localhost:5432 Postgres server and create the database mundo_nexus_db with CREATE DATABASE mundo_nexus_db. TypeORM should be able to handle table creation - mock data is up to you.

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.