xfarrow
/
blink
mirror of https://github.com/xfarrow/blink
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
xfarrow 2024-02-29 16:03:28 +00:00 committed by GitHub
parent d9e79be200
commit b5d3cf1536
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
backend/apis/README.md
View File

@ -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.