Docker - lesson 7 | HackIndia Skills

Docker - lesson 7 | HackIndia Skills | HackIndia

Example

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"}.

Tip

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_testing

Make The Repo Recruiter-Ready

One simple test

What reviewers look for

Repo checklist

README run section

Use .env.example

Common weak README

Test like a reviewer

Do this now

Quick check