Quick Start

Quick Start

This guide will help you get the RideEase Android application up and running on your local development environment.

Prerequisites

Before you begin, ensure you have the following installed:

• Android Studio (Latest stable version recommended)
• Java Development Kit (JDK) 11 or higher
• Git installed on your machine
• A Firebase Account to set up backend services

1. Clone the Repository

Clone the project to your local machine using the following command:

git clone https://github.com/ItsMeVikashKumarSingh/RideEase.git
cd RideEase

2. Configure Firebase

RideEase relies on Firebase for authentication and database management. You must link your own Firebase project to the app.

1. Go to the Firebase Console.
2. Create a new project named RideEase.
3. Register a new Android App within the project:
   • Package Name: com.rideease.app (This must match the package defined in the project manifests).
4. Download the google-services.json file.
5. Move the google-services.json file into the app/ directory of your cloned project.

Enable Firebase Services

In the Firebase Console, enable the following services:

• Authentication: Enable Email/Password and Phone sign-in providers.
• Firestore Database: Create a database in Start in test mode (for initial development) and choose a location.

3. Build the Project

1. Open Android Studio.
2. Select File > Open and navigate to the cloned RideEase folder.
3. Wait for the IDE to finish the Gradle Sync.
   • Note: If you encounter sync errors, ensure your google-services.json is in the correct app/ folder and that you have an active internet connection.

4. Run the Application

1. Connect a physical Android device (with USB debugging enabled) or start an Android Emulator.
2. Click the Run button (green play icon) in the Android Studio toolbar.
3. The app will launch on the Splash Screen.

Initial Setup Flow

To test the application features, follow the standard onboarding flow:

1. Select User Role: On the Login or Signup screens, choose between the Rider or Driver categories.
2. Create Account: Register with a valid email and a password (minimum 6 characters).
3. Verify Email: Check your inbox for a Firebase verification email to activate your account.
4. Complete Profile: Upon first login, you will be redirected to the UserDetailsActivity to provide:
   • Full Name
   • Phone Number (linked via the country code dropdown)

Common Troubleshooting

| Issue | Resolution | | :--- | :--- | | Gradle Sync Failed | Ensure the package name in google-services.json is exactly com.rideease.app. | | Authentication Error | Ensure Email/Password and Phone providers are enabled in the Firebase Auth console. | | Firestore Permission Denied | Check your Firestore security rules; they must allow reads/writes for authenticated users. | | Phone Verification Failed | Ensure you have added your SHA-1 fingerprint to the Firebase Project Settings for Phone Auth to work. |