Deployment
Your submission is not only your app. It is your live URL plus a public repo that explains how to run, build, and configure it.
Assume a recruiter opens it on a phone during a short break. They should understand the project in two minutes.
0 of 7 lessons done · proved by a submitted project with a public repository
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
Use this as a simple README structure. Do not paste secret values. Only write variable names and what they are for.
# Campus Mess Feedback
A web app for students to submit mess food feedback and for admins to view common issues.
## Live demo
https://your-app-url.com
## Tech stack
- React
- Node.js
- PostgreSQL
## Setup
1. Clone the repo
2. Install dependencies
3. Create a .env file using the variables below
4. Run the app locally
## Commands
npm install
npm run dev
npm run build
## Environment variables
DATABASE_URL=your_postgres_connection_string
JWT_SECRET=your_login_secret
NEXT_PUBLIC_APP_URL=your_app_url
## Test login
Student: [email protected] / password123
Admin: [email protected] / password123
## Notes
The deployed app uses a hosted PostgreSQL database.Never commit your .env file, database password, API keys, or JWT secret. Reviewers need the variable names, not your real values.
If you already pushed a secret, rotate it in the provider dashboard. Deleting the line later is not enough because Git history may still contain it.
Ask ChatGPT, Gemini, or Claude to improve your README. Paste your current README and say: “Make this clear for a recruiter. Keep setup steps, build command, env variable names, live demo, and test login.”
Check the output. AI may invent commands, tools, or features. Keep only what matches your actual project.
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 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
Answer the quick check to finish this lesson.