One simple test
A recruiter-ready repo passes the fresh laptop test. Someone should clone it, create the required environment file, run docker compose up, and see the app locally.
Do not assume they know your college project folder, your local database name, or your secret keys.
What reviewers look for
Your Dockerfile and Compose file prove the app can run outside your laptop. Your README proves another human can use it.
Think of the README as your project’s first interview answer. It should explain what the app does, how to run it, and what to check after it starts.
Repo 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 6 done
README run section
Use a copy-paste section. Keep it boring and exact. Replace the names and ports with your project details.
Run locally with Docker
1. Clone the repo
git clone https://github.com/your-name/your-project.git
cd your-project
2. Create the environment file
cp .env.example .env
3. Start the app and database
docker compose up --build
4. Open the app
http://localhost:3000
Expected result
You should see the login page. If you are testing the API, open http://localhost:3000/health and expect {"status":"ok"}.Use .env.example
Commit .env.example, not .env. The example file tells reviewers what variables exist without leaking passwords, tokens, or UPI/payment test keys.
Use safe dummy values. If a value must be created by the reviewer, write a comment beside it.
# .env.example
APP_PORT=3000
DATABASE_URL=postgres://app_user:app_password@db:5432/app_db
POSTGRES_USER=app_user
POSTGRES_PASSWORD=app_password
POSTGRES_DB=app_db
JWT_SECRET=change_me_for_local_testingCommon weak README
Beginners often write only: run npm install, start Postgres, set env, run the app. That defeats the point of this track.
If the project uses Compose, the main path should be Docker first. Native setup can be a second section, not the main proof.
Test like a reviewer
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 5 done