Reviewer-ready beats done
Your submission is not just code. It is a public repo that a teammate, judge, or recruiter can open and understand in five minutes.
Before you submit, check the repo from a stranger’s view. They should see what the app does, how to run it, where the API is, and what environment variables are needed.
Final repo check
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done
README finish block
Add a short submission block near the top of your README. Keep it practical. A reviewer should not search through paragraphs to find the basics.
Project: Mess Splitter
What it does:
A simple app for hostel friends to add shared expenses and see who owes whom.
Live demo:
Add your deployed app link here, if available.
Main stack:
Next.js, API routes, SQLite with Prisma
Run locally:
1. Clone the repo
2. Copy .env.example to .env
3. Run npm install
4. Run npm run dev
5. Open http://localhost:3000
Environment variables:
DATABASE_URL="file:./dev.db"
API proof:
POST /api/expenses adds an expense
GET /api/expenses returns saved expenses
Test account or sample data:
Use any name and amount on the Add Expense page.Do not hide setup
A common mistake is writing only “npm install and npm run dev”. That is not enough for a full-stack repo.
If your app needs a database URL, API key, seed command, or login steps, write them clearly. If reviewers cannot run it, they will assume it is unfinished.
Use AI as reviewer
Paste your README into ChatGPT, Gemini, or Claude and ask: “Can a first-time reviewer run this project from these instructions? List missing steps only.”
Check the answer yourself. AI may invent commands or misunderstand your stack. Only add steps you have tested locally.
Submission checklist
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done
Do this now
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 4 done