|
1 | 1 | # TimeKeeper |
2 | 2 |
|
3 | | -A time tracking and sign-in management system built for FRC (FIRST Robotics Competition) teams. Track team member attendance across sessions and locations with support for RFID check-in/out, Discord integration, and multi-platform clients. |
| 3 | +A time tracking and sign-in management system built for FRC (FIRST Robotics Competition) teams. Track team member attendance across sessions and locations with support for RFID check-in/out (PCSC or keyboard emulation), Discord integration, and multi-platform clients and servers. |
4 | 4 |
|
5 | | -## Features |
| 5 | +Conceptualised from other attendance systems like 254's [Cheesy Hours](https://github.com/Team254/cheesy-hours) and 3132's [Attendance](https://github.com/Team3132/attendance) systems. Built to be generic and easy to setup with minimal overhead and no external requirements, using an embedded key-value db and simple 3rd party API integrations. |
6 | 6 |
|
| 7 | +## Features |
7 | 8 | - **Session Management** - Create and manage timed sessions at configurable locations |
8 | 9 | - **RFID Check-In/Out** - Supports both PCSC smart card readers and keyboard-emulating RFID readers |
9 | 10 | - **Kiosk Mode** - Dedicated fullscreen mode for check-in stations |
10 | | -- **Discord Bot** - Session reminders, attendance commands, leaderboards, and member name syncing |
| 11 | +- **Discord Bot** - Session reminders, attendance commands, leaderboards, and member name syncing, self checkouts |
11 | 12 | - **Schedule Import** - Import sessions from CSV or ICS (iCalendar) files |
12 | 13 | - **Multi-Platform Clients** - Desktop (Linux, Windows, macOS), Android, and Web |
13 | 14 | - **Real-Time Sync** - gRPC streaming keeps all connected clients in sync |
| 15 | + |
| 16 | +## Quickstart |
| 17 | +1. Download the server from the latest [release](https://github.com/CurtinFRC/TimeKeeper/releases) |
| 18 | +2. Run it on a device of your choice (cloud server, local, rpi etc...) |
| 19 | +- Note: (Run the command `server.exe --help` for start config commands. I.e `server.exe --web-port 80`) |
| 20 | +3. Navigate to the servers address using the set port or default port 8080. I.e (`http://10.128.22.120:8080`) |
| 21 | +4. Login using the button in the top right of the app bar (default username `admin`, default password `admin`) |
| 22 | +5. Using the left rail navigation bar enter the setup page and configure the setup (import ICS or CSV calendar, student and mentor data, notifications etc...) |
| 23 | +- Note: Connect to discord first and import users through discord to pre-link their accounts in the system for later use if using discord |
| 24 | + |
| 25 | +## Documentation |
| 26 | +Check [documentation](https://curtinfrc.github.io/TimeKeeper/) for more details. |
0 commit comments