Back-end

Production:

• Build:
• Website: https://nahual-datos-voluntaries.herokuapp.com/

Documentation

This project has Node.js as a server-side and React as front-end framework to create the UI.

API documentation

• You can see the document here

ORM with TypeORM

• Using Data Mapper Pattern

Database

• PostgreSQL v12.1

Deployment

• Using Node.js buildpack.

Available scripts

Install Tools

• nvm: You can follow the following instructions
• yarn: You can follow the following instructions
• node: nvm install 12.14.0

Set node version

Stand on the repository root and execute: nvm use

Install dependencies

yarn install

Run server in development mode

Runs the app in the development mode. Open http://localhost:5000 to view it in the browser.

yarn dev

The page will reload if you make edits.

Code formatter

For time saving and good practices, we use prettier. You only need to run the following instruction:

yarn format:all

Tests

yarn test

Linter

yarn lint

Javascript Compilation

Builds the app for production to the build folder.

yarn build

Database

Development setup

• Runs the database container in the background:

yarn db:start

• Runs up the database container:

yarn db:up

• Stops the database container:

yarn db:stop

Connections

Create

• Creates the current NODE_ENV stage database

yarn db:create

• Creates the test database

yarn db:test:create

Migrate

• Migrates the current NODE_ENV stage database

yarn db:migrate

• Migrates the test database

yarn db:test:migrate

Drop

• Drops the current NODE_ENV stage database

yarn db:drop

• Drops the test database

yarn db:test:drop

Shortcut

• Drops, creates and migrates the current NODE_ENV stage and test database

yarn db:all:reboot