{"id":22460540,"url":"https://github.com/p1utoze/Hackme","last_synced_at":"2025-08-02T05:31:05.065Z","repository":{"id":170705971,"uuid":"646877233","full_name":"p1utoze/Hackme","owner":"p1utoze","description":"A fast, minimalistic participant management system for your hackathon 🚀","archived":false,"fork":false,"pushed_at":"2024-12-02T16:32:00.000Z","size":1091,"stargazers_count":0,"open_issues_count":6,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-02T17:38:35.118Z","etag":null,"topics":["fastapi","firebase","hackathon-project","python","registration-system"],"latest_commit_sha":null,"homepage":"https://hackme.cloudns.nz","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/p1utoze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-29T14:40:17.000Z","updated_at":"2024-05-17T21:13:44.000Z","dependencies_parsed_at":"2024-06-24T18:14:51.590Z","dependency_job_id":"b76671ef-1591-4433-86f2-f783c9eed0e8","html_url":"https://github.com/p1utoze/Hackme","commit_stats":null,"previous_names":["p1utoze/fastapi-aventus","p1utoze/hackme"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1utoze%2FHackme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1utoze%2FHackme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1utoze%2FHackme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1utoze%2FHackme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/p1utoze","download_url":"https://codeload.github.com/p1utoze/Hackme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228439523,"owners_count":17920023,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","firebase","hackathon-project","python","registration-system"],"created_at":"2024-12-06T09:02:26.672Z","updated_at":"2024-12-06T09:06:16.304Z","avatar_url":"https://github.com/p1utoze.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://results.pre-commit.ci/badge/github/p1utoze/Hackme/main.svg\"\u003e\n\u003c/p\u003e\n\n# Hackme\nA minimalistic open-source web-application that serves as hackathon registration and participant status monitoring. Initally developed as a event management tool for [Hackaventus](https://hackaventus.com/)- A national level hackathon. It is designed to handle large amount of user registrations.\n\n## Features\n\n- Instant QR Code Registration\n- Restricted Access for Organizing Team ✉️\n- Single scan, multiple functionalities 📨\n- Supports Google SSO and Firebase Auth with email and password 🤔\n- Participant management dashboard\n- Automatic participant status update through ID scan\n- Hackme application usage flowchart:\n\n![Hackme application flowchart](./assets/Hackme.drawio.svg)\n\n## Get started\nTo use this app, check out my hosted website: [hackme](https://hackme.cloudns.nz)\n\n### Prerequisites\n\n- Install project dependencies using pip\n```\npip install -r requirements.txt\n```\n- Rename the `.env.template` to `.env` and replace the placeholders. Refer [Environment Variables configuration](SETUP.md/#environment-variables-configuration\n) for more details.\n\n- Add the users who can access the application to the firebase project. Refer [Setting up Organizing Team Database](SETUP.md/#setting-up-organizing-team-database) for more details.\n\n### Usage\n\n- **Uvicorn:** To run the app locally with uvicorn server on port `\u003cport\u003e`.\n```\nuvicorn app.main:app --reload --port \u003cport\u003e\n```\n- **Docker:** To run the app locally with docker on port `\u003cport\u003e`.\n```\n$ docker pull p1utoze/hackme:v1.8\n$ docker run -p \u003cport\u003e:80 --env-file .env p1utoze/hackme:v1.8\n```\n**NOTE:** Ensure the callback url port is the same as the port specified in the command. Refer [Environment Variables configuration](SETUP.md/#environment-variables-configuration\n) for more details.\n\n### Python\n\nNeeds: Python 3.X, virtualenv\n\nStable at Python v.3.8.X and 3.10 (tested at Python 3.8.17 and 3.10)\n\n### Roadmap\nI 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.\n### Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n","funding_links":[],"categories":["Tooling"],"sub_categories":["Organizing"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fp1utoze%2FHackme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fp1utoze%2FHackme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fp1utoze%2FHackme/lists"}