compass / README.md

Compass

Last updated: 4/16/2026GitHub

Compass

Rihal Compass is an internal learning and training platform built to prepare new trainees for real company projects. It centralizes structured learning paths, progress tracking, mentor evaluations, and training materials helping trainees become self-sufficient while reducing workload on busy employees.

Problem Statement

New trainees often join without the required technical readiness to contribute to real production tasks. Meanwhile, engineers and full-time employees have tight schedules and cannot provide daily one-on-one training.

Rihal Compass solves this by offering a centralized dashboard for learning, automated progress tracking and efficient tools for mentors and admins to guide trainees without interrupting operational work.

Getting started

System Architecture

View Architecture Diagram image

Figma

Pre-requisites

list all pre-requisites for the project

  • React (v22)
  • Docker (v24+)
  • Go (v1.22+)

Project setup

Clone the repository

git clone {{https://github.com/rihal-om/compass.git}}
cd {{compass}}
#### Running the app locally
> -- hello world example --
1. Run docker-compose to start the application
```bash
docker-compose up
# or 
make run
  1. Populate the database with sample data
make populate
# or
docker-compose exec app python manage.py populate_db
  1. Once the application is running, open your browser and navigate to:
# Frontend
http://localhost:3000
# Backend
http://localhost:8080
# keycloak
http://localhost: 8081

Tech Stack

-- example tech stack --

CategoryToolDescription
FrontendReact viteUI library/framework
BackendGo echoServer-side language/framework
AuthenticationKeycloakIAM system
DatabasePostgresqlRelational/NoSQL DB
ContainerizationDockerContainer platform
CI/CDGithub ActionsWorkflow automation

Project Team

NameRoleGitHub
{{PM_NAME}}Project Manager@{{PM_GH}}
DEVOPS_mohammed Al-KhusaibiDevOps Engineer@mohammedyk7
DEVOPS_mohammed Al-ShabibiDevOps Engineer@mohammed-alshabibi
FE_ishaq AL-BalushiFrontend Developer@Engishaqalbalushi
FE_Sameer Al-BalushiFrontend Developer@N6q
BE_Rahma Al-MamariBackend Developer@rahmaAlmamari
BE_Fatema Al-SaaidiBackend Developer@FatemaALSAAIDI
BE_Ahmed Al-SubhiBackend Developer@AhmedAlSubhi99

Feel free to reach out to any of us for questions, feedback, or collaboration opportunities. We are always open to discussing new ideas and improvements for the project.

Happy coding!