Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.37 KB

README.md

File metadata and controls

59 lines (36 loc) · 1.37 KB

Basic Onboarding API

Getting Started

To get a copy of this project up and running on your local machine for testing and development, you would need to have a minimum of the listed prerequisites installed on your local machine.

Prerequisites

You must have

  1. Node.js (v8.12.0 or higher) and npm (6.4.1 or higher) installed on your local machine. Run node -v and npm -v in your terminal to confirm that you have them installed

  2. GIT and Bash

Installation

To get started, clone this repository on your local machine using the following steps:

Open your terminal and navigate to the folder you want the project to be and enter the the following commands:

npm ci

Create a .env file and add the environment variables described in the .env.sample file.

Starting the dev server

npm run dev

Starting the production server

npm start

Running migrations

npm run migrate:up
npm run migrate:down

Technologies

  • Node JS
  • Express
  • Postgres

Documentation

Postman Documentation: https://documenter.getpostman.com/view/14860785/UVRAHRrm

Hosting Platform

App Hosted on Heroku: https://onboarding-api.herokuapp.com/api/v1/

Send me an email if you have any questions 📥