The Rebus Ink "Reader" server is an API for research workflow to support researchers to better manage and draw insights from their collected sources.
Key libraries:
- Express: a back-end web application framework for Node.js.
- Objecitve: an ORM.
- Knex: a SQL query builder.
- Passport: authentication with JSON web tokens.
- Flow: static type checker.
Key third-party services:
- Google Cloud Platform: deployment and services including Cloud Storage and Cloud SQL - PostgreSQL.
- Redis Labs: in-memory data structure store and cache.
For more details, see the Overview Guide.
See the front-end service Development Guide for instructions on setup and testing.
The documentation for the routes is available at https://rebusfoundation.github.io/reader-api.
This project is still in the very early stages and is not yet ready for unsolicited contributions. If you are interested in the project, please contact the development team.
Rebus Ink "Reader" API Server is released under the GNU GENERAL PUBLIC LICENSE. Some third-party components are included. They are subject to their own licenses. All of the license information can be found in the included LICENSE file.