diff --git a/README.md b/README.md index 5eaccd1..8762bdc 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,60 @@ -# patbond_flutter +# Patbond Flutter -A new Flutter project. +Patbond is a Flutter learning project. The current goal is to build the basic app frame for a social content app with a layout similar to Xiaohongshu. -## Getting Started +## Current Progress -This project is a starting point for a Flutter application. +- Flutter project initialized. +- App entry extracted into `lib/app/app.dart`. +- Main shell page created with a bottom navigation bar. +- Home page connected as the first tab. +- Basic project notes added under `doc/`. -A few resources to get you started if this is your first Flutter project: +## Project Structure -- [Learn Flutter](https://docs.flutter.dev/get-started/learn-flutter) -- [Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Flutter learning resources](https://docs.flutter.dev/reference/learning-resources) +```text +lib/ + main.dart + app/ + app.dart + features/ + home/ + home_page.dart + main/ + main_shell_page.dart +doc/ + android_development.md + common_app_structure.md + main_app_const.md + project_structure.md +``` -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +## Run The App + +Install dependencies: + +```bash +flutter pub get +``` + +Run in debug mode: + +```bash +flutter run +``` + +Or open the project in VS Code, select a device, and press `F5`. + +## Development Plan + +Near-term steps: + +1. Replace placeholder tabs with real feature pages. +2. Build a basic home feed page. +3. Add note card models and mock data. +4. Add theme configuration. +5. Add detail pages and navigation when the main frame is stable. + +## Git Notes + +Generated files such as `.dart_tool/`, `build/`, IDE workspace files, and local platform configuration should not be committed.