jennyChoudhry / directory-mock-server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Directory Mock Server

A Microservice API utilizing Node JS and Express.

What: A mock server to enable parallel workstreams between iOS, Web, Android and Back-end platforms. The services in this application are meant to serve as API contracts between the client and backend platforms.

Prerequisites

NPS

Directory Mock Server uses nps to define and execute npm scripts without the cost of a bloated package.json and the limits of JSON.

npm start is defined (in package.json) as an alias for nps, hence all scripts are run via npm start <...>

Docker

Install Docker

brew install docker

and Docker for Mac

Setup

Clone this repo

git clone https://github.com/jennyChoudhry/directory-mock-server
cd directory-mock-server

Install all dependencies

npm install

Run app in a terminal window:

npm start

The application can also be run containorized with npm start container and stopped with npm start container.clear

Application is running on http://localhost:4000

Contributing

See Contributing.md

Architecture Design Record

See ADR.md

About


Languages

Language:JavaScript 94.1%Language:Dockerfile 5.9%