xfarrow
/
blink
mirror of https://github.com/xfarrow/blink
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
blink/backend/apis
History
xfarrow 7f45379ebc Add API usage 2024-10-30 15:36:50 +01:00
..
nodejs Add API usage 2024-10-30 15:36:50 +01:00
BlinkApiUsageExampleBRUNO.json Add API usage 2024-10-30 15:36:50 +01:00
BlinkApiUsageExamplePOSTMAN.json Add API usage 2024-10-30 15:36:50 +01:00
README.md update 2024-10-24 17:37:08 +02: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 an API client (such as Insomnia, Bruno or Postman) 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.