Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.52 KB

README.md

File metadata and controls

57 lines (39 loc) · 1.52 KB

GitHub issues GitHub last commit Analytics

Image

Bootcamp-api

Backend API for Bootcamp Web Application, which is a bootcamp directory website

Dependencies

In order to run this server, you need to have installed the following dependencies:

  1. Node - min v8.15.0
  2. NPM - min v5.6.0 or
  3. Yarn - min v1.3.2
  4. Bash terminal (Default on OSX/Linux, GitBash or similar on Windows)

Details

JS

Folder structure:

  • _data/ - default seed data
  • config/ - database configuration and environment variables
  • controllers/ - abstraction controller layer
  • middleware/ - error handling middleware, authentication middleware, logger, and pagination
  • models/ - database schema configuration
  • public/ - documentation web page
  • routes/ - API routes
  • utils/ - utility and helper functions

Usage

Rename "config/config.env.env" to "config/config.env" and update the settings to your own

Install dependencies

npm instal

Run App

# Run in dev mode
npm run dev

# Run in production mode
npm start
  • Version: 1.0.0
  • License: MIT