TypeScript - lesson 8 | HackIndia Skills

Key point

Proof beats claims

A TypeScript project is not proven by saying “built with TypeScript”. It is proven when a reviewer can open your repo, install it, run one command, and see the type-check or build pass.

Your goal is simple: make your repo easy to inspect in five minutes.

Your to-do

What your repo needs

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.

Keep your TypeScript source in a clear folder, usually src.
Commit config files such as package.json, tsconfig.json, and your lockfile if you use one.
Add scripts for type-checking or building, so nobody guesses commands.
Write setup steps in README.md from clone to run.
Show proof that the project passes a build or type-check.

0 of 5 done

Example

Useful package scripts

Your scripts should match your project. A plain TypeScript app may use tsc. A Vite app may use vite and tsc. Do not copy commands that fail in your repo.

Before submission, run the same command you put in the README.

{
  "scripts": {
    "dev": "vite",
    "typecheck": "tsc --noEmit",
    "build": "tsc && vite build"
  }
}

Example

README setup section

A recruiter or judge may be checking your repo late at night after many submissions. Help them run it without DMing you.

Mention Node.js if your app needs it. Keep environment variable names clear, but never commit real secrets.

# Campus Expense Splitter

A small TypeScript app to split group expenses for college trips and hostel orders.

## Tech stack
- TypeScript
- Vite
- React

## Setup
1. Clone the repo
2. Run npm install
3. Run npm run typecheck
4. Run npm run dev

## Build proof
Last checked locally:
npm run typecheck
Result: passed

## Notes
Create a .env file from .env.example if you use API keys.

Tip

Use AI carefully

You can ask ChatGPT, Gemini, or Claude to review your README before submission. Paste your README and package.json, then ask: “Can a first-time reviewer run this TypeScript project from these steps?”

Check the answer yourself. AI may suggest commands for tools you do not use. Only keep commands you have tested in your own terminal.

Common mistake

Common submission mistake

Many builders submit a repo that works only on their laptop. Missing scripts, missing env examples, or a README with old commands can make a good project look broken.

Another mistake is hiding TypeScript errors with any just before submission. Lesson 7 already covered this. For your final repo, prefer a smaller working feature over a larger unsafe one.

Your to-do

Final repo check

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.

Run npm install in a fresh folder if you can, then run the README commands.
Run npm run typecheck or npm run build and confirm it passes.
Commit your latest typed source, README.md, package.json, and tsconfig.json.
Push to a public GitHub repository.
Open the repo in an incognito window and check that the files are visible.

0 of 5 done

Your to-do

Do this now

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.

Add or fix your typecheck and build scripts in package.json.
Write a README section with setup, run, and type-check commands.
Run the exact command you will show as proof.
Push your final changes to a public repo.
Save the repo link for your HackIndia submission.

0 of 5 done

Submit your typed project repo

Proof beats claims

What your repo needs

Useful package scripts

README setup section

Use AI carefully

Common submission mistake

Final repo check

Do this now

Quick check