Codr is an open-sourced customizable annotation tool for researchers and industry being developed by the PERC_Lab.
This is the start to a improved version of Codr which can be found on Github and hosted at https://codr.dylanbulmer.com.
- CodrJS/API • [repo] • This contains the code for our RESTful API built on the @CodrJS/Core module
- CodrJS/setup • [repo] • k8s and service configuration documentation
- CodrJS/docs • [repo] (private repo) • End user documentation for Codr
- CodrJS/WebUI • [repo] • This is the fround-end web client that interacts with the RESTful API
View all packages on npmjs.org!
| Version | Name | Repo | Image | Purpose | Notes |
|---|---|---|---|---|---|
 |
@codrjs/config |
repo | npmjs.org | Pulls environment variables into a unified JSON object. | |
 |
@codrjs/core |
repo | npmjs.org | being deprecated | |
 |
@codrjs/design-library |
repo | npmjs.org | Storybook UI/UX library | docker image |
 |
@codrjs/health |
repo | npmjs.org | Monitors health data of the service. | |
 |
@codrjs/kafka |
repo | npmjs.org | Customized kafka classes for easier integration. | |
 |
@codrjs/logger |
repo | npmjs.org | Unifies logging output for observability | |
 |
@codrjs/models |
repo | npmjs.org | Contains all data models for Codr | |
 |
@codrjs/mongo |
repo | npmjs.org | Contains ORMs for Codr data models |
ts-npm-template• [repo]ts-microservice-template• [repo] [docker image]
All microservices are hidden within an internal kubernetes network. In the future, a Nginx server will be deployed on top of these services and expose the endpoints by proxying the routes to the correct location.
| Type | Name | Repo | Image | Purpose | Notes |
|---|---|---|---|---|---|
| Entity | codr-config |
repo | ghcr.io | Config domain entity manager. | Dataset and other configs? |
| Entity | codr-preference |
repo | Preference domain entity manager. | User preferences for privacy, notification, etc. | |
| Entity | codr-template |
repo | Template domain entity manager. | Email, SMS, and push notification templates. | |
| Entity | codr-user |
repo | ghcr.io | User domain entity manager. | User identification, used heavily in authentication. |
| Entity | codr-profile |
repo | ghcr.io | Profile domain entity manager. | Profile information for non-anonymous users. |
| Entity | codr-usergroup |
repo | ghcr.io | User Group domain entity manager. | Grouping users together for project collaboration. |
| Entity | codr-project |
repo | ghcr.io | Project domain entity manager. | Project configuration, e.g. display customization. |
| Entity | codr-dataset |
repo | ghcr.io | Dataset domain entity manager. | Links samples together and links to a project |
| Entity | codr-sample |
repo | ghcr.io | Sample domain entity manager. | Uploaded sample for dataset |
| Entity | codr-annotation |
repo | ghcr.io | Annotation domain entity manager. | Annotation provided by user for sample. |
| Service | codr-audit-svc |
repo | Audit domain processing service. | Consumes event streams to log actions | |
| Service | codr-notification-svc |
repo | ghcr.io | Notification domain processing service. | Consumes event streams to automate notifications |
| Serivce | codr-bff |
Backend-for-frontend | Intermediary between the browser and API layers for security. |
