Skip to content

README.md

Latest commit

 

History

History
154 lines (117 loc) · 4.65 KB

README.md

File metadata and controls

154 lines (117 loc) · 4.65 KB
Raw

Military Ride-Share App

The Military Ride-Share App is a secure and efficient Flutter-based platform designed exclusively for military personnel and their dependents. It facilitates seamless ride-sharing within the military community, ensuring safe and reliable transportation options tailored to their unique needs.

Features

  • User Authentication: Robust verification process to ensure access is restricted to military members and dependents.
  • Ride Management:
    • Riders can request rides and track progress in real-time.
    • Drivers can accept or decline ride requests and manage availability.
  • Location Services: Real-time GPS for accurate pickup and drop-off points.
  • Notifications: Instant updates for ride status and confirmations.
  • Payment Integration: Secure, cashless transactions between riders and drivers.
  • Military-Specific Filters: Search rides to and from bases, duty stations, and military events.
  • Admin Tools: Manage user roles, verify military credentials, and oversee platform activity.

Tech Stack

  • Frontend Framework: Flutter
  • Backend: Firebase
    • Authentication
    • Realtime Database
    • Cloud Functions
    • Storage
  • Deployment: Google Cloud (for Firebase backend)

Prerequisites

Before you begin, ensure you have the following installed:

  • Flutter SDK
  • Android Studio or Xcode (for mobile emulators)
  • Firebase CLI
  • Git

Getting Started

  1. Clone the Repository

    git clone https://github.com/yourusername/military-ride-share.git  
cd military-ride-share

  2. Install Dependencies

    flutter pub get

  3. Set Up Firebase

    • Create a Firebase project in the Firebase Console.
    • Add Android and iOS apps to the project and download the configuration files:
      • google-services.json for Android
      • GoogleService-Info.plist for iOS
    • Place these files in their respective directories:
      • Android: android/app/
      • iOS: ios/Runner/

  4. Run the Application

    flutter run

Project Structure

military-ride-share/  
├── lib/  
│   ├── screens/              # App screens (e.g., Home, Login, Profile)  
│   ├── widgets/              # Reusable Flutter widgets  
│   ├── services/             # Firebase and API integrations  
│   ├── models/               # Data models (e.g., Ride, User)  
│   ├── providers/            # State management using Riverpod  
│   └── main.dart             # App entry point  
├── android/                  # Android-specific files  
├── ios/                      # iOS-specific files  
├── assets/                   # Images, fonts, and other static resources  
├── pubspec.yaml              # Flutter dependencies and metadata  
└── README.md                 # Project documentation

Firebase Configuration

Ensure your Firebase project is set up to enable the following features:

  • Authentication: Enable Email/Password and any other login methods you need.
  • Realtime Database: Add rules to secure data for verified users only.
  • Cloud Functions: Write custom backend logic for notifications and verifications.

Deployment

The app can be deployed to the respective app stores once completed:

  1. Generate Build Files:

    • Android: 
      flutter build apk --release
    • iOS: 
      flutter build ios --release

  2. Test on Devices:

    • Use Firebase Test Lab or physical devices for testing.

  3. Submit to App Stores:

    • Android: Upload the APK to the Google Play Console.
    • iOS: Archive and distribute the app through Xcode to the App Store.

Future Enhancements

  • Analytics: Integrate Firebase Analytics for user activity insights.
  • Ride Scheduling: Allow users to schedule rides in advance.
  • In-App Messaging: Enable communication between riders and drivers.
  • Dynamic Pricing: Adjust rates based on if servicemember is job searching or coming back from a deployment.

Contributing

We welcome contributions!

  1. Fork the repository.
  2. Create your feature branch: 
    git checkout -b feature/amazing-feature
  3. Commit your changes: 
    git commit -m 'Add amazing feature'
  4. Push to the branch: 
    git push origin feature/amazing-feature
  5. Open a pull request.

License

This project is licensed under the MIT License.