Hackathon Kit

A small, reusable workspace for turning an idea into a clear, reviewable submission.

Project README · Demo script · Submission checklist · Team workflow

Built by Om Denkar for hackathons across themes: AI, education, developer tools, web products, and whatever the next problem needs.

Start here

1. Select Use this template → Create a new repository.
2. Copy templates/PROJECT_README.md to the root README.md and replace its prompts with your project's facts.
3. Agree on one user, one problem, and one end-to-end demo flow. Use the task form under Issues → New issue to break it into work.
4. Build, test, and rehearse with the demo outline.
5. Complete the submission checklist before the deadline.

This is a documentation and collaboration starter. It contains no application, deployment, or runtime dependencies. You choose the stack that fits the event.

What's inside

File	Purpose
templates/PROJECT_README.md	The problem, demo, setup, architecture, contribution, and limits in one place
docs/DEMO.md	A two-minute working-demo outline and fallback plan
docs/SUBMISSION.md	A final check for access, links, reproducibility, and event requirements
docs/WORKFLOW.md	A lightweight team workflow for scope, ownership, and review
.github/ISSUE_TEMPLATE/task.yml	Tasks with an owner, acceptance check, and demo relevance
.github/ISSUE_TEMPLATE/bug.yml	Reproducible bug reports and impact on the demo
.github/pull_request_template.md	Focused changes with evidence and remaining risks

Use at an event

Read the specific event's rules before reusing this kit or any existing code. Record starter code, previous work, external assets, APIs, and AI assistance where required. A polished README does not make an existing project eligible for a new event.

Use sample data for the demo, keep credentials out of the repository, and describe mocked or incomplete features honestly. Add a license to your application only after your team has agreed on the terms and checked dependencies and assets.

Why this structure

GitHub's README guidance emphasizes explaining what a project does and how to start. MLH's judging guide recommends short videos that show the hack working. This kit puts those two needs first; your event's rubric takes priority.