Key point
One idea
Your project is not shipped when it works on your laptop. It is shipped when a stranger can open the repo, understand it, run it, and see the JavaScript skills you used.
Your to-do
JavaScript
Your project is not shipped when it works on your laptop. It is shipped when a stranger can open the repo, understand it, run it, and see the JavaScript skills you used.
0 of 8 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
Your README should answer three questions fast: what is it, how do I run it, and where is the JavaScript skill visible.
Keep it honest. If one feature is incomplete, say so in a small “Known issues” section instead of hiding it.
# Campus Event Finder
A small JavaScript app that fetches event data and helps students filter events by category.
## Features
- Fetches event data from an API or local JSON file
- Shows events as cards
- Filters events by category
- Handles loading and error states
## JavaScript used
- Modules: code is split across files in `src/`
- Functions: rendering, filtering, and API calls are separate
- Arrays and objects: event data is stored and filtered as objects in an array
- fetch and async/await: data is loaded asynchronously
## How to run
1. Clone the repo
2. Open the project folder
3. Start a local server
```bash
npx serve .
```
4. Open the local URL shown in the terminal
## Known issues
- Data is not saved after refresh
- Search works only by categoryDo not submit only a live demo link. A recruiter or hackathon reviewer needs the repo too.
Also avoid vague READMEs like “run the project”. Say the exact command. If your app needs an API key, explain where to add it and never commit the key.
You can ask ChatGPT, Gemini, or Claude to review your README and repo structure. Ask it to check clarity, not to invent features you did not build.
Verify every suggestion. AI may add fake commands, fake API details, or claim your code uses a concept that is not actually present.
Prompt:
Review this README for a beginner JavaScript hackathon project. Check if a reviewer can run it from scratch. Do not add features that are not mentioned. Point out missing setup steps, unclear commands, and places where the JavaScript skills are not visible.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
Your last commit should tell a human what changed. Avoid messages like “final final” or “changes”.
Small, clear commits make the repo easier to read later during internship shortlisting.
git status
git add .
git commit -m "Add README and final project setup steps"
git pushDo 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.