#node-dummy-api
The development / dummy API is written in Node and runs on localhost
on port 1337
.
##Code Dependencies:
- NodeJS JavaScript framework (instructions below)
- Node Package Manager (npm) JavaScript package manager for Node (included with Node installation)
##Requirements and Initial Setup:
- Download and install NodeJS on your machine (npm, aka Node Package Manager, also comes bundled with NodeJS) if you haven't already; Node is also required to build the AngularJS application so you may have already installed it
- Run the
npm install
command from the project root directory (the same directory containing this README) to install the Node packages via thepackage.json
file (if you get anEACCESS
error, you will have to run this command with Administrator/root access) - Run
npm install -g nodemon
to install thenodemon
package globally. This will allow the Node dummy API server to restart itself automatically if changes are made to theserver.js
file
##Root Directory Contents:
/.git
- source control.gitignore
- list of files/directories to exclude from source controlREADME.md
- project notes, setup instructionspackage.json
- configurationJSON
file for Node server dependenciesserver.js
- Node server code / dummy API
##Files that should be ignored by source control (.gitignore
):
node_modules
- directory containing Node dependencies and build tools