amineelhailaa/hifd_quran

HIFD Quran is a full web application built to help students memorize the Quran. It has a Java backend built with Spring Boot, a React frontend built with Vite, a PostgreSQL database for storing information, and Keycloak for handling logins and user identity. The application lets anyone browse Quran chapters, verses, reciters, and audio recordings without logging in. Once a student logs in through Keycloak, they can create memorization plans, track study sessions, build up streaks for consistent practice, monitor their overall progress, and save favorite chapters for later. Administrators get their own read-only view into student memorization status so they can follow along with how students are progressing. Internally, the backend follows a layered architecture that separates the core business rules from the technical details of how data is stored or how the web API works, which is meant to keep the underlying logic independent from any particular database or framework choice. The codebase is organized into separate modules for user identity, the memorization features, the Quran content itself, and shared utilities used across the others. Getting the whole system running locally is done through Docker Compose, which starts the frontend, backend, database, and Keycloak together with one command, and separate profiles let you choose a development or production frontend. There are also commands for seeding the database with Quran text and reciter information, and instructions for running the frontend or backend on their own outside of Docker if you prefer. The project includes a continuous integration pipeline that runs backend tests, frontend checks, and a full integration test with the database and Keycloak running together, along with instructions for deploying the whole stack to a plain server without needing a domain name. The README does not mention a license, so the terms under which the code may be reused are not stated.