Auwalms / middleware

Middleware layer implementing API connection to databases and authentication

middleware

• Overview
  • Technologies Used
• Getting Started
  • Prerequisites
  • Installing/Running locally
• Contributors (Maintainers)

0. Overview

Middleware layer implementing API connection to databases and authentication

0.1 Technologies Used

1. Node.js
2. Express.js
3. And others...

1. Getting Started

1.1 Prerequisites

Ensure you have the following installed on your local machine.

• NodeJS

1.2 Installing/Running locally

• Clone repository

    - git clone https://github.com/BanTheBad/middleware.git
    - cd middleware
    - npm install

• Create/configure a .env file with your credentials. A sample .env.example file has been provided to get you started. Make a duplicate of .env.example and rename to .env, then configure your credentials.

• Two npm scripts are available to spin up the server:

  • npm run dev spins up the server and watch for file changes
  • npm run dev:debug spins up the server and attaches a debugger to it

2. Contributors (Maintainers)