Java - lesson 8 | HackIndia Skills

Key point

Repo is the proof

Your project is not finished when it works on your laptop. It is finished when another builder can clone it, build it, run it, and understand what it does.

For HackIndia submission, your public repo must include the build file, source code, sample data, and clear run instructions.

What reviewers check

A recruiter-style Java CLI project should look boring in a good way. The folder names should be normal. The commands should be copy-paste friendly.

Do not depend on hidden files, local absolute paths, or your IDE. Someone should be able to run it from Terminal, PowerShell, or a college lab machine with Java and Maven or Gradle installed.

Your to-do

Final repo checklist

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 source code under src/main/java.
Keep sample input under data or src/main/resources.
Commit your Maven pom.xml or Gradle build.gradle.
Add a README with setup, build, run, and sample output.
Make the repository public before you submit.

0 of 5 done

Example

README that works

Use simple instructions. Mention the Java version you tested with. Show the exact command you expect someone to run.

This example assumes a Maven app that reads a JSON file from data/candidates.json.

# Recruiter CLI

A Java command-line app that reads candidate data and prints a shortlist.

## Requirements

- Java 17
- Maven 3.9 or later

## Build

mvn clean package

## Run

mvn exec:java -Dexec.mainClass="com.hackindia.recruiter.Main" -Dexec.args="data/candidates.json"

## Sample data

The sample file is included at:

data/candidates.json

## Expected output

Shortlisted candidates:
1. Asha Sharma - Java, SQL
2. Imran Khan - Java, Git

## Project structure

src/main/java - Java source code
data - sample input files
pom.xml - Maven build file

Common mistake

Avoid local paths

Do not write paths like C:\Users\Rahul\Desktop\candidates.json or /home/me/project/data.json in your code or README. They only work on your machine.

Accept the file path as a command-line argument, or use a relative path like data/candidates.json in examples.

Tip

Test like a stranger

Before submitting, make a fresh clone in a different folder. Run only the README commands. If anything is missing, fix the repo and test again.

You can ask an AI tool to review your README, but check that it does not invent commands, plugins, folders, or features your project does not have.

git clone https://github.com/YOUR-USERNAME/recruiter-cli.git test-run
cd test-run
mvn clean package

Your to-do

Submission flow

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.

Push your final code to GitHub or another public Git host.
Open the repo in a private browser window to confirm it is public.
Check that sample data is committed and not ignored by .gitignore.
Copy the public repo URL into your HackIndia project submission.
Add a short project description that matches what the CLI actually does.

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.

Create or update your README with build and run commands.
Add one sample data file that your CLI can read.
Clone your repo into a new folder and run it from the README only.
Fix any missing files, wrong commands, or local paths.
Submit the public repo link on HackIndia when the clean run works.

0 of 5 done

Submit your public repo

Repo is the proof

What reviewers check

Final repo checklist

README that works

Avoid local paths

Test like a stranger

Submission flow

Do this now

Quick check