History

xfarrow b4b70b524d Rate limiter in another file		2024-03-20 16:56:16 +01:00
..
nodejs	Rate limiter in another file	2024-03-20 16:56:16 +01:00
BlinkApiUsageExample.json	Update BlinkApiUsageExample.json	2024-03-20 12:19:05 +01:00
README.md	Update README.md	2024-03-06 09:20:49 +00:00

README.md

APIs

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.

For Developers

The current implementation of the Blink APIs is written in NodeJS. Feel free to develop them in any other programming language (you can paste the folder here) but make sure to make them compatible with one another and please follow the API design's best practices.