Welcome to alkemi-earn-api 👋
A Rest API that provides data for the Alkemi Earn Protocol
✨ Docs
Prerequisites
node ^12.9.1
npm >= 3.0.0
nodemon (https://www.npmjs.com/package/nodemon)
Install
Setting Environment Variables
Create a new .env file based off the example. Make sure there are no spaces for the values
Then run
Usage
Production
Development
Run tests
Coverage
Runs coverage script and stores data under ./coverage, open ./coverage/icov-report/index.html to see the coverage.
For windows:
Authentication
See: https://docs.feathersjs.com/guides/basics/authentication.html#registering-a-user
.env
To make the API work properly, you need an .env var on the same directly as the index.js file (base of /src)
Example:
N.B: HOST (for example: localhost:3030) & PROTOCOL (for example: http) env variables are important to be set properly to have swagger working, especially for local testing (as by default PROTOCOL will be set to https)
Author
👤 Alkemi
Website: https://alkemi.network
Twitter: @AlkemiOfficial
Github: @project-alkemi
🤝 Contributing
Contributions, issues and feature requests are welcome! Feel free to check issues page.
Last updated