https://github.com/joduplessis/relic
Relic is a straightforward NodeJS/MongoDB framework for writing USSD enabled applications, managing users & basic API access to the data using JWTs.
https://github.com/joduplessis/relic
api express jwt mongodb nodejs ussd
Last synced: about 1 month ago
JSON representation
Relic is a straightforward NodeJS/MongoDB framework for writing USSD enabled applications, managing users & basic API access to the data using JWTs.
- Host: GitHub
- URL: https://github.com/joduplessis/relic
- Owner: joduplessis
- License: mit
- Created: 2018-02-25T09:56:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-25T10:07:40.000Z (over 7 years ago)
- Last Synced: 2024-12-26T00:23:06.109Z (6 months ago)
- Topics: api, express, jwt, mongodb, nodejs, ussd
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Relic
Relic is a straightforward NodeJS/MongoDB framework for writing data-enabled USSD applications.
## Installation
Clone the repo and install packages with `yarn install` or `npm install`. Make sure you fill out the `Constants` file with the relevant details (Mongo port, etc.).
## USSD
Point your USSD service to `/ussd`. You can follow the code to add more conversation paths.
## Add users
To add users for API & data access, simply run `npm run register `.
## Get data
You can access the entry data at `/entries` by passing your `bearer` JWT auth token in each request header.
# Roadmap
- Better handling of conversation
- More flexible data structure for entrant details