Track My Attendance

Track My Attendance is a platform designed to help students easily monitor their class attendance and predict trends in their presence across different subjects.

The key features are:

Simplicity First: A streamlined user experience focused on easy attendance tracking.
User-friendly: Intuitive interface without unnecessary complexity—no overwhelming menus or buttons.
Minimalist Approach: Offers only the essentials to keep your attendance organized and accessible.

Technology Stack and Features

Backend
- FastAPI — High performance Python web framework for building APIs.
- SQLAlchemy — for the Python SQL database interactions.
- Pydantic — used by FastAPI, for the data validation and settings management.
Frontend
- Svelte — Modern and reactive framework for building highly efficient user interfaces.
Security
- Secure password hashing by default.
- JWT (JSON Web Token) authentication.
Testing and CI/CD
- Tests with Pytest.
- CI (continuous integration) based on GitHub Actions.

Contributing

Thank you for your interest in contributing to the "Track My Attendance" project!

Reporting bugs

If you discover a bug, first check the GitHub issues page to see if issues have already been reported.

Please use the "Bug Report" template and provide detailed information about the problem, including steps to reproduce it.

Suggesting Features

If you want to suggest a new feature or improvement, first check the GitHub issues page to ensure a similar suggestion hasn't already been made.

Use the "Feature Request" template to provide a detailed description of your suggestion.

Questions

If you have any questions or need clarifications, join the discussion on the GitHub Discussions page.

Contributing Code

Before submitting code changes, check if there are similar pull requests already open. This will prevent duplicate efforts. Please follow these guidelines:

Requirements for Merging a Pull Request

The requirements to accept a pull request are as follows:

Adhere to project coding standards, formatting, and linting rules. Make sure you check the guidelines for each component.
Write comprehensive tests and ensure all tests pass.
Maintain or improve test coverage — no reductions are allowed.