Flutter Project
Welcome to the Flutter project! This repository contains the source code for a Flutter application. Follow the guide below to set up the project and start development.
Table of Contents
- Prerequisites
- Setup Instructions
- Running the Project
- Building the Application
- Troubleshooting
- Contributing
- Resources
Prerequisites
Ensure you have the following installed:
- Flutter SDK: Download Flutter
- Git: Download Git
- Code Editor: Visual Studio Code (recommended) or Android Studio
- Mobile Device/Emulator: A physical device or an emulator/simulator
- Internet Connection: For downloading dependencies and packages
macOS Specific:
- macOS Version: macOS 10.14 (Mojave) or newer
- Xcode: Download Xcode
- CocoaPods: Install using
sudo gem install cocoapods
Windows Specific:
- Windows Version: Windows 10 or newer
- Android Studio: Install for Android SDK and tools
- PowerShell: Version 5.0 or newer
Setup Instructions
Cloning the Repository
- Open your terminal (macOS) or Command Prompt/PowerShell (Windows).
- Clone the repository:
git clone <repository_url> cd <repository_name>
Installing Flutter
Follow the official Flutter installation guide for your operating system:
Configuring Environment Variables
macOS:
- Add Flutter to your PATH in
.zshrc
or.bash_profile
:export PATH="$PATH:/path_to_flutter/bin"
- Apply changes:
source ~/.zshrc
Windows:
- Add Flutter to your PATH in System Environment Variables:
- Example:
C:\flutter\bin
- Example:
Installing Dependencies
Navigate to the project directory and run:
flutter pub get
Platform-Specific Setup
macOS (iOS Development):
- Install CocoaPods dependencies:
cd ios pod install cd ..
- Open the iOS project in Xcode:
open ios/Runner.xcworkspace
Windows (Android Development):
- Configure Android Studio:
- Open Android Studio and go to
Preferences > Appearance & Behavior > System Settings > Android SDK
. - Ensure required SDK tools (e.g., Android 12.0, SDK Build Tools) are installed.
- Open Android Studio and go to
- Accept Android licenses:
flutter doctor --android-licenses
Running the Project
- Connect a physical device or start an emulator.
- Run the project:
flutter run
Building the Application
-
Build APK (Android):
flutter build apk
-
Build iOS App (macOS only):
flutter build ios
Troubleshooting
- Run
flutter doctor
to check for any issues:flutter doctor
- Clean the project and fetch dependencies again:
flutter clean flutter pub get
- Refer to the official Flutter troubleshooting guide.
Contributing
- Fork the repository.
- Create a new branch for your feature or bugfix.
- Make your changes and test thoroughly.
- Submit a pull request with a detailed explanation of your changes.
Resources
Thank you for contributing! If you have any questions, feel free to open an issue.
Libraries
- components/Custom/CoustomDropDown/CoustomDropDown
- components/Custom/CustomHeadingText/CustomHeadingText
- components/Custom/CustomInput/CustomInput
- components/Custom/CustomOptBox/CustomOptBox
- components/Custom/Loader/loader
- main
- modules/3DFace/3Dfaceintro
- modules/3DFace/facedetect
- modules/AddressVerification/AddressVerificationstep1
- modules/AddressVerification/AddressVerificationstep2
- modules/Bvnnumber/Bvnnumberstep1
- modules/country/countryselect
- modules/email/emailid
- modules/email/otp_screen
- modules/Idverification/IdverificationIntroducation
- modules/Idverification/Idverificationstep2
- modules/Idverification/Idverificationstep3
- modules/Ninnumber/Ninnumberstep1
- modules/phone/phoen_otp_screen
- modules/phone/phonenumber
- modules/ProgressBar/ProgressBar
- modules/SuccessScreen/SuccessWidget
- redux/actions
- redux/reducers
- redux/store
- themes/colors