This repository contains a simple PHP-based application that allows users to manage “modules” (courses) and their associated requirements or tasks. It includes functionality for:
- User registration, login, and logout
- Tracking module requirements, credits, and progress
- Admin panel (for user management)
All data (user accounts and module information) is stored in JSON files statically – no database needed. Thus this application is only recommended for small-scale use or as a learning project.
- A web server with PHP support (e.g., Apache, Nginx)
- PHP 7.0 or higher
- This repository is ready to use in a web server environment.
- Clone or download the repository to your local machine or directly to your public directory.
- IMPORTANT: Make sure to use a web server that supports PHP and
.htaccessfiles! Otherwise, the application may not work as expected and could expose sensitive information.
- Users can register by providing a username and password.
- Passwords are hashed for security.
- After registration, users can log in to their accounts.
Edit mode can be activated by the respective link at the top, or by pressing the e key.
Changes to requirements will be saved automatically.
Users can
- add/view/update/delete modules to their profile and requirements to those modules
- A Requirement can be any task, such as a project, exam, assignment or even just a deadline
- mark requirements as completed
- highlight requirements blue (checkbox next to the name)
- view a summary of the progress in terms of completed requirements, credits earned and the average grade
- A grade can only be entered if the requirement has more than 0 credits and is marked as completed.
- You can only ever edit one requirement at a time, and will have to hit
Updatebefore you can edit another one.
Users can View All Requirements by Date to see all their requirements sorted by date with helpful information like how many days are left or how many days are inbetween two requirements.
The User can also filter the requirements by module, and search for requirements by name or description. Use an exclamation mark to search for exact matches like "!Exam" to find requirements with that exact name.
Requirements are clickable and completable in the homeand Requirements by Date view, which will open a details page where users can see the details of the requirement, attach notes and add Sub-Requirements if the task needs more detailed abstraction.
- The application provides a summary of completed requirements and credits earned under the
Statspage. - It also includes charts to visualize progress over time including:
- linear lines for the set targets
- lines for the actual and planned progress
- Grade averages over time
A target term is a possible term where the user wants to have reached the target credits. Users can set multiple target terms, and the application will calculate the required credits per term to reach the target and show that below each term and in the chart.
Users have the option to set an id for each module and select Usernames to share information with at the top in edit mode (putting * as shared username will share with every user). The id will be shown to other users, and modules with the same id will show a handy note that the respective other user is also working on this module. Additionally when sharing, users will be able to see a progress line in the stats page where users can compare their progress with other users.
- You can add the requirements with dates as events to your calendar using the iCal path
/calendar.ics?username=USERNAME&password=PASSWORD. - Just put this link (with your domain/path, username and password) into your calendar app and it will automatically add the events to your calendar.
This project is licensed under the Non-Commercial Public Use License (NCPUL).
You can use, modify, and share it freely as long as you don't charge for it or use it in any way that generates revenue.
Commercial use, monetization, and paid access are strictly prohibited.
See LICENSE for full terms.