You want to always document your code - this includes actual source code in-line documentation, but also API documentation
This project depends on a few global libraries (listed below). I've included notes on installing them.
You will want to install this on your machine to get started - You probably don't have it yet. The best first step, would be to install brew. Here is a link on that: https://brew.sh/. Probably best to install node via brew.
Run the following to install npm via brew:
brew install npm
Hopefully that works ;)
Run the following to install node via npm:
npm install --global node node-dev
We're using node-dev as our NPM start script, for now. In production, we would switch the start script to node index.js
These are the endpoints currently available with this app. The app does not yet require authentication.
Here's sample code using the example-service endpoint:
GET http://localhost:3500/example-service
// Nothing in the body
{}Here's a sample response:
{
"message": "Hello World!"
}