MonoCorpus is a tool to record code, notes, and papers during the development of software and machine learning algorithms. It lets you lookup previous bugs and relevant notes to quickly solve new problems and bugs.
This repo is a collection of microservices and scripts to deploy the service. It is being reorganized during its transition from a private repo, so some things may be nonfunctional or pointing to nonexistent code.
- Full Text Search
- Chronological ordering of notes
- Title Filters
- import Arxiv abstracts
- KaTeX support
- Markdown support
- Image support (beta)
How it Works
MonoCorpus uses Vuejs on the frontend, GraphQL as a gateway layer between HTTP and grpc calls, and golang microservices in the backend.
MonoCorpus relies on Keycloak for user auth, traefik as a proxy to the backend, and Elasticsearch for full text search.
- CRUD functions to Mongo.
- GraphQL interface to notes and search.
Monocorpus should be installed inside of your $GOPATH at
create an .env file in
monocorpus/docker. It should have the following variables:
ENV=dev NETWORK=docker HOST=localhost POSTGRES_DATA_LOC=/data/postgres POSTGRES_USER=loginUserAdmin POSTGRES_PASSWORD=adminpw MONGO_DATA_LOC=/data/mongo SEARCH_DATA_LOC=/data/es KEYCLOAK_USER=admin KEYCLOAK_PASSWORD=admin KEY=INSERT_KEYCLOAK_REALM_PUBLIC_KEY
Deployment requires the gateway to be aware of keycloak's public key for token decryption.
docker-compose up -d keycloakto bring up the keycloak instance.
- Find the notes realm public key and replace the dummy key in the
- Elasticsearch may need permissions to write to your elasticsearch data directory. Run
chown -R 1000:1000 esto fix this.
- Keycloak's realm requires knowledge of valid redirect urls. If you are not running on localhost, this needs to be changed.
docker-compose up -dto bring the whole system up.
Search - Elasticsearch
Proxy - Traefik
Authentication - Keycloak
How to Contribute
Please feel free to send me a PR. There's a lot of low-hanging fruit across this project -- refactoring, documentation, testing. Let me know if there's something you want to work on and we can discuss.
Please rebase PRs if necessary -- https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request