diff --git a/backend/apis/README.md b/backend/apis/README.md index c937b4d..1f6ab6a 100644 --- a/backend/apis/README.md +++ b/backend/apis/README.md @@ -1,5 +1,18 @@ # APIs -To start APIs, run `node ./nodejs/src/app.js ` +## Programming language +The Blink APIs are currently written in NodeJS only. -Open `BlinkApiUsageExample.json` with Insomnia to see APIs in action. +## Prerequisites +* PostgreSQL; +* NodeJS. + +## Deploying +In order to deploy the Blink APIs, follow these steps: +* Configure the `.env` file in `./nodejs/src/`. +* Run `node ./nodejs/src/app.js` + +## Testing the APIs +You can test the APIs in two ways: +* Open `BlinkApiUsageExample.json` with Insomnia or Bruno in order to have the collection of APIs already configured and ready to be seen in action; +* Run `npm test` in `./nodejs` to run a suite of automated tests.