A minimalistic open-source web-application that serves as hackathon registration and participant status monitoring. Initally developed as a event management tool for Hackaventus- A national level hackathon. It is designed to handle large amount of user registrations.
- Instant QR Code Registration
- Restricted Access for Organizing Team ✉️
- Single scan, multiple functionalities 📨
- Supports Google SSO and Firebase Auth with email and password 🤔
- Participant management dashboard
- Automatic participant status update through ID scan
- Hackme application usage flowchart:
To use this app, check out my hosted website: hackme
- Install project dependencies using pip
pip install -r requirements.txt
-
Rename the
.env.templateto.envand replace the placeholders. Refer Environment Variables configuration for more details. -
Add the users who can access the application to the firebase project. Refer Setting up Organizing Team Database for more details.
- Uvicorn: To run the app locally with uvicorn server on port
<port>.
uvicorn app.main:app --reload --port <port>
- Docker: To run the app locally with docker on port
<port>.
$ docker pull p1utoze/hackme:v1.8
$ docker run -p <port>:80 --env-file .env p1utoze/hackme:v1.8
NOTE: Ensure the callback url port is the same as the port specified in the command. Refer Environment Variables configuration for more details.
Needs: Python 3.X, virtualenv
Stable at Python v.3.8.X and 3.10 (tested at Python 3.8.17 and 3.10)
I have mentioned the features I have planned to implement in the future in the issues. If you have any suggestions, please feel free to open an issue.
Contributions are welcome! Please feel free to submit a Pull Request.