|
1 | | -# enmay_flutter_starter |
| 1 | +# New Project Setup |
2 | 2 |
|
3 | | -Flutter Starter Template |
| 3 | +Follow these steps when setting up a new project from this starter template: |
4 | 4 |
|
5 | | -## Getting Started |
| 5 | +## 1. Initial Setup |
6 | 6 |
|
7 | | -This project is a starting point for a Flutter application. |
| 7 | +```bash |
| 8 | +# Basic setup (dependencies + code generation) |
| 9 | +flutter pub run setup:new |
8 | 10 |
|
9 | | -A few resources to get you started if this is your first Flutter project: |
| 11 | +# Full setup (includes iOS pods) |
| 12 | +flutter pub run setup:full |
| 13 | +``` |
10 | 14 |
|
11 | | -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) |
12 | | -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) |
| 15 | +## 2. Change Package Name |
13 | 16 |
|
14 | | -For help getting started with Flutter development, view the |
15 | | -[online documentation](https://docs.flutter.dev/), which offers tutorials, |
16 | | -samples, guidance on mobile development, and a full API reference. |
| 17 | +- Use this command to change package name: `flutter pub run change:package com.new.package.name` |
| 18 | +- Replace `com.new.package.name` with your desired package name |
| 19 | + |
| 20 | +## 3. Update Project Metadata |
| 21 | + |
| 22 | +- Update `name` and `description` in `pubspec.yaml` |
| 23 | +- Update app name in platform-specific files: |
| 24 | + - Android: `android/app/src/main/res/values/strings.xml` |
| 25 | + - iOS: Open `ios/Runner.xcworkspace` and update display name |
| 26 | + |
| 27 | +## 4. Firebase Configuration |
| 28 | + |
| 29 | +- Create a new Firebase project in Firebase console |
| 30 | +- Enable Authentication, Firestore, and Crashlytics |
| 31 | +- Use `flutterfire configure` to connect the project to your app |
| 32 | +- This will generate/update: |
| 33 | + - `lib/firebase_options.dart` |
| 34 | + - `android/app/google-services.json` |
| 35 | + - `ios/Runner/GoogleService-Info.plist` |
| 36 | + |
| 37 | +## 5. Platform-Specific Setup |
| 38 | + |
| 39 | +### iOS Setup |
| 40 | + |
| 41 | +```bash |
| 42 | +flutter pub run ios:setup |
| 43 | +``` |
| 44 | + |
| 45 | +### Android Setup |
| 46 | + |
| 47 | +- Verify `android/app/google-services.json` is properly configured |
| 48 | +- Update app icon and splash screen if needed |
| 49 | + |
| 50 | +## 6. Revenue Cat (Optional) |
| 51 | + |
| 52 | +If using the paywall feature: |
| 53 | + |
| 54 | +- Create a RevenueCat account |
| 55 | +- Configure your products and entitlements |
| 56 | +- Update the RevenueCat API keys in your environment variables |
| 57 | + |
| 58 | +## 7. Environment Configuration |
| 59 | + |
| 60 | +- Create `.env` file for environment variables |
| 61 | +- Configure development vs production settings |
| 62 | +- Update theme colors and branding in `lib/src/app/theme/` |
| 63 | + |
| 64 | +## 8. Final Verification |
| 65 | + |
| 66 | +```bash |
| 67 | +# Run analysis and tests |
| 68 | +flutter pub run setup:verify |
| 69 | + |
| 70 | +# Test on both platforms |
| 71 | +flutter run |
| 72 | +``` |
| 73 | + |
| 74 | +## 9. Version Control |
| 75 | + |
| 76 | +- Update this README with project-specific information |
| 77 | +- Remove template-specific content |
| 78 | +- Set up your Git repository and make initial commit |
0 commit comments