Lesson 3 - Build a portfolio that gets replies | HackIndia Skills | HackIndia

Turn code into a strong repo

Key point

One thing to remember

A strong repo is easy to review. A stranger should quickly see where the app starts, where the code lives, and whether the project can be run safely.

Clean the shape

Start with the top-level view. If the root folder has random files, old drafts, and final-v2 names, clean it before you write a better README.

Keep the structure simple. Do not add folders just to look serious. Use names people understand.

Example

Folder example

For a small web app, this is enough. Source code goes in src. Public files go in public. Notes can go in docs.

Before

my-project/
  app.js
  index.html
  styles.css
  logo-final-new.png
  test123.js
  readme draft.txt

After

my-project/
  src/
    app.js
    components/
  public/
    logo.png
  docs/
    notes.md
  README.md
  package.json

Your to-do

Use commits well

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.

Quick check

0 of 2 right

1.Your repo has node_modules, .env, and old test files in the root. What should you fix first?

2.You finished three changes: moved files, added validation, and updated package scripts. What is the best commit habit?

Answer the quick check to finish this lesson.

← Lesson 2 Skip to lesson 4 →

git add src/app.js
git commit -m "move app logic into src folder"

git add public/logo.png README.md
git commit -m "add project logo and usage notes"

git add package.json
git commit -m "add scripts for local run and build"

Example

Ignore local junk

A .gitignore stops local files from entering GitHub. Add it before you push secrets or heavy folders by mistake.

Example .gitignore for Node

node_modules/
.env
.DS_Store
dist/
coverage/

Tip

License choice

Add a license only if you want others to reuse or build on your code. MIT is a common simple choice for open sharing.

If you use MIT, use the standard MIT text from a trusted source. Update the copyright line with your name and year.

LICENSE

Use a standard MIT text from a trusted source, then update the copyright line with your name and year.

Example

UPI tracker example

Say you built a UPI expense tracker. Move app code into src, keep screenshots in public or assets, and keep notes in docs. Add .gitignore so .env and node_modules stay out of GitHub.

Then commit in small steps: create src structure, add expense form validation, ignore local config and build output.

package.json example

{
  "name": "upi-expense-tracker",
  "version": "1.0.0",
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "preview": "vite preview"
  }
}

Turn code into a strong repo

One thing to remember

Clean the shape

Folder example

Use commits well

Quick check

Add expected files

Ignore local junk

License choice

UPI tracker example

Common repo mistakes

Do this now