Flutter - lesson 7 | HackIndia Skills

Key point

One clear proof

Your repo should prove three things fast: the code runs, the app was tested, and the demo can be understood in two minutes.

A recruiter or judge should not need to message you for setup steps.

Your to-do

Before you push

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 flutter analyze from the project folder.
Run flutter test if your project has tests.
Run flutter devices to confirm your emulator or Android phone is visible.
Run the app once on the same device you mention in the README.
Remove local secrets, unused files, and random test screenshots.

0 of 5 done

Example

README starter

Create or update README.md at the root of your repo. Keep it honest. If a feature is pending, say so.

# Campus Food Finder

A Flutter Android app that shows nearby budget food spots for college students.

## Features
- Home screen with food places from an API
- Detail screen for each place
- Saved places stored on the device
- Android demo build tested on a phone/emulator

## Tech stack
- Flutter
- Dart
- HTTP API
- Local device storage

## Setup
1. Install Flutter on the stable channel.
2. Clone this repo.
3. Run:
   flutter pub get
   flutter run

## Demo steps
1. Open the app.
2. Wait for the food list to load.
3. Tap any item to open details.
4. Save one place.
5. Restart the app and check that the saved place remains.

## Build and test evidence
- Tested on: Android emulator or phone model name
- Command used for APK: flutter build apk --split-per-abi
- Install check: flutter install

## Screenshots
Add 2 to 4 screenshots here: home, detail, saved screen, phone install.

Tip

Use AI carefully

You can ask ChatGPT, Gemini, or Claude to improve your README. Paste your real feature list and ask for a short setup guide.

Check every command it returns. Do not keep fake features, fake APIs, or tools you did not use.

Common mistake

Common repo mistakes

Do not submit only an APK. The task is a public repository with runnable source code and proof that it was built and tested.

Do not leave the README as the default Flutter text. That tells the reviewer you did not package the project properly.

Your to-do

What to include

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.

Include the full Flutter project source, including pubspec.yaml and lib folder.
Include a README with setup, run, demo, and testing notes.
Include screenshots or a short screen recording link if your platform allows it.
Mention the Android device or emulator used for testing.
Add the APK build command you used, not just the final file.

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.

Open your project folder and run flutter analyze.
Update README.md using the starter structure above.
Add 2 to 4 screenshots from your phone or emulator.
Push the latest code to a public repo.
Open the repo in an incognito window and check that the README makes sense.

0 of 5 done

Submit your public repo

One clear proof

Before you push

README starter

Use AI carefully

Common repo mistakes

What to include

Do this now

Quick check