toni-21 / g-app-template

Basic Application template

Apparance.io Flutter starter kit (Free version)

🔥 This template is a highly simplified version of our pro starter kit.

• firebase firestore
  
• Riverpod for state management
• Simplified architecture
• Basic github CI

Wanna use standard backend?
The pro version is for you.

Getting Started

🔥 Run the demo

You must have flutter properly installed on your computer. If not, please follow the official documentation.

Run on Android

Then launch VSCode and run the 'Development' configuration.
(Left pane > Run and Debug > Development > Start Debugging)

Run on iOS

You must first configure your iOS environment.
Please follow the guide here.
Then launch VSCode and run the 'Development' configuration.
(Left pane > Run and Debug > Development > Start Debugging)

As this project is setup for demo you must follow the installation guide to setup your own backend and firebase project.

Features

Features	Included	Pro version
🧪 Multiple environments (dev,staging,prod...)	✅	✅
📦 Modular architecture example	✅	✅
📲 Repository pattern example	✅	✅
⏳ App initializer	✅	✅
👨‍💻 Authentication state	✅	✅
🔓 Guards example	✅	✅
📭 Email signup page	✅	✅
📱 Easy bottom bar setup (+ adaptive with OS)	✅	✅
🚩 Basic Unit tests examples	✅	✅
🖥️ Basic CI setup	✅	✅
🎨 Enhanced theme manager	❌	✅
🚀 CLI commands	❌	✅
🔁 Switch between firebase / standard backend (CLI command)	❌	✅
🔐 Password recovery page	❌	✅
🖥️ Advanced CI setup	❌	✅
🚩 Advanced Unit tests examples	❌	✅
💼 Regular dependencies versions check	❌	✅
🔔 Handle notifications	❌	✅
💰 In app subscription (optionnal)	❌	✅
🤩 Google Ad mobs ready (optionnal)	❌	✅
😎 Social authentications (CLI command)	❌	✅
📂 Storage api + download / upload example	❌	✅
📄 Complete documentation	❌	✅
... and many more

Need more features? 🔥 Check the pro version

📘 Guides

Setup guides

• How to install
• Adding social authentications (not available in the free version)
• Subscription module (not available in the free version)

Development guides

• App architecture (not available in the free version)
• Used Plugins and packages
• Writing a module
• Codes practices (not available in the free version)
• Routes and navigation
• Api and Http requests (not available in the free version)
• Setup notifications (not available in the free version)
• Localisation (not available in the free version)
• Testing: how to write effective tests (not available in the free version)
• Handling errors and monitoring (not available in the free version)

Deployment guides

• Customize splashscreen and App icon
• How to create a flavor on iOS / Android
• Prepare for deployment
• Deploy your app on the Apple Store
• Deploy your app on the Google Play Store
• Setup Gitlab CI (not available in the free version)
• Setup Github CI (not available in the free version)
• Setup with codemagic CI (Easier and faster than Gitlab / Github) (not available in the free version)

Going further

• Show ads with AdMob (not available in the free version)
• Deep links (not available in the free version)

👉 Code generation

As we use code generation in the whole project. You must run this command to regenerate all the generated code from @freezed or other like json. For more info refer to the freezed package documentation.

dart pub run build_runner build --delete-conflicting-outputs

📦 Code architecture

As an app grow and can include more and more people, we prefer to make modular architecture as it prevent code conflicts.

Depending on the complexity of your project you can add another layer between object returned by firestore as Entities. So it will look like this. Firestore collection > entities > repository > model

File structure

TODO

• core // shared code
• modules // all modules codes environments // environments configurations main.dart // main app entry

---