This is a project that is built for Manupatra. This project is called manureader. This repo is the backend for manureader. The manureader project is a platform where multiple people can collaborate and edit the document at the same time. They can highlight and annotate parts of the pdf and create notes to review later. This project is built using Ruby on Rails.
Platform Architecture
- The platform implements a public GraphQL API.
- Authentication is managed via an access_token which is sent as an Authorization Header.
- User Interfaces consumes the GraphQL API
- The admin panel of the project is built on CM Admin, which is a gem managed by Commutatus
Tech Stack
- Ruby on Rails
- CM-Admin
System Requirements
Third Party Tools
- Postmark for transactional emails.
- GlitchTip for tracking errors.
- Scout for monitoring.
- AWS S3 for storing files.
Deployment
- Deployments are triggered to Hatbox via an their "Automated Deployment" feature. The
stagingbranch is deployed to the staging environment, and themainbranch is deployed to the production environment.
Credentials
- Postmark API Key
- Sentry DSN link
- Scout key
- AWS Access Key and Secret
Running locally
- To run this project in localhost, do the following:
bundle installrails db:setuprails s