This API is currently in development. See the "Contributing" section below to know more about how to help.
The AniRate REST API is intended both for the Discord bot and for public sources (such as websites) related to it.
It is currently written in TypeScript, and we chose MongoDB as our go-to database engine, along with Redis caching. We currently are using Express, Overnightjs, Mongoose and other open-source libraries. We're trying to follow the REST principles, and chose a simple monolith architecture.
The API is currently hosted on Heroku (hence the Procfile), and makes use of MongoDB Atlas and Redislabs.
We follow the "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes NOTE: Be sure to merge the latest from "upstream" before making a pull request!
For major changes, please open an issue first to discuss what you would like to change. Issues for bugs, suggestions and ideas are welcome too.
Remember to be kind and that this project is not the only thing we have to work on in our lives.
This project was brought to life thanks to @Mazino's idea and the API (as of today) is entirely written by @DanielVip3. Any contributor will subsequently be listed in this section.
This project is distributed under the new BSD License (3-clause).