The GitHub account that becomes your CV
Set up the account you may still be using five years from now, and learn what a reviewer actually looks at when they open it.
Every phase of this course ends with a public repository. By Phase 08, that GitHub account may be one of the strongest parts of an application, so choose a username you will still be happy to share later.
Here is what a reviewer usually does: they open your repository, read the README and decide very quickly whether to keep going. Most will not run the code unless the project gives them a reason to.
For most readers, the README is their first real impression of the project. Explore the anatomy below. Hover any part to highlight the matching Markdown, then flip the toggle to compare it with the version many people ship by default.
Anatomy of a README
Aurora: a product card
A single-page product card built to practise type scale and contrast. No framework, no build step.
Live: aurora-card.vercel.app
npm install && npm run dev- Radius varies by element size
- Greys carry a green bias
- Stock pill failed contrast, fixed
# Aurora: a product cardA single-page product card built to practise type scale andcontrast. No framework, no build step.**Live:** https://aurora-card.vercel.app## Running it```bashnpm installnpm run dev```## What I decided- Radius varies by element size (14px card, 9px button)- Greys carry a green bias so they belong to the palette- The stock pill failed contrast at 3.4:1, now 4.8:1
Hover or tab through either panel: the two are the same document.
Three things matter in particular. Add a live link so a reviewer can try the project immediately. Add a screenshot for anyone who will not run it. Then include a short section on what you decided and why, because that is what makes your version feel like your work rather than a copy of the same exercise.
You should now be able to
- Create a professional GitHub presence
- Write a README a stranger could follow
- Say what an employer looks for in a side project
Loading…