updated

Author: raddi1972

.gitignore

@@ -39,8 +39,3 @@ app.*.symbols
 
 # Obfuscation related
 app.*.map.json
-
-# Android Studio will place build artifacts here
-/android/app/debug
-/android/app/profile
-/android/app/release

README.md

@@ -1,18 +1,91 @@
-# carpool
+# ShareCab : An organisation carpool app ! 
 
-A new Flutter project.
+## Problem Statement :-
 
-## Getting Started
+Often in college we have noticed the messages like " who is going to airport on this day and this time from campus".  This is not only limited to college but also in large organisation where people have to depend on traditional WhatsApp messages and phone calls which makes the entire benifit of going together becomes a burden ! 
 
-This project is a starting point for a Flutter application.
+## Our Solution :- 
 
-A few resources to get you started if this is your first Flutter project:
+We decided to help people to carpool by creating a mobile application which serves as a one stop check for everyone in the same organisation to carpool! The app mainly consist of a login screen which serves as a login as well as registration screen. The validity of the email is verified via OTP ([attribution](https://pub.dev/packages/email_auth)). This is followed by a simplistic UI where a user can add their booking as well as check how many might be already travelling during that slot.  Once we have booked we can regularly come back to the app and check if someone else have also booked a slot to travel together. You can get the details of the user (Name, Email ID. This can be extended to more fields as per the organisation's preference) and can connect to travel together ! There is also a delete option added which can help you remove yourself from the list of travellers on a particular slot. For now we create this model for a uni-directional travel (i.e From College to Airport or vice versa ) but this can be easilty scaled up to add Location based support also.  
 
-- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
+## Technologies Utilized :-
 
-For help getting started with Flutter, view our
-[online documentation](https://flutter.dev/docs), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+The following set of technologies have been used for this project:
 
-sdvlknesjdvn
+**1) Firebase** (for cloud storage/database)
+
+**2) Flutter** (UI and platform)
+
+**3) Dart** (Interfacing the UI and database)
+
+## Screenshots  :-
+
+<img src="https://github.com/ishaanj0412/Carpool/blob/a34bccce77ff397a046ceb1f21234082e04688fd/Readme_pics/1.jpeg" alt="Login" width="30%" /> <img src="https://github.com/ishaanj0412/Carpool/blob/a34bccce77ff397a046ceb1f21234082e04688fd/Readme_pics/2.jpeg" alt="OTP verification" width="30%" /> <img src="https://github.com/ishaanj0412/Carpool/blob/5117ac76994f4798224ed47ff5238edf50db24d9/Readme_pics/3.jpeg" alt="HomeScreen" width="30%" />
+
+
+<img src="https://github.com/ishaanj0412/Carpool/blob/5117ac76994f4798224ed47ff5238edf50db24d9/Readme_pics/4.jpeg" alt="4" width="30%" /> <img src="https://github.com/ishaanj0412/Carpool/blob/60946ab891803ac79ece6e02e62e1a033c15d625/Readme_pics/5.jpeg" alt="5" width="30%" /> <img src="https://github.com/ishaanj0412/Carpool/blob/a34bccce77ff397a046ceb1f21234082e04688fd/Readme_pics/6.jpeg" alt="6" width="30%" /> 
+
+
+
+# How to run the project
+
+- ### For Testing and use :-
+
+  - Download the .apk file from this [link](https://github.com/ishaanj0412/Carpool/releases/download/Release/carpool.apk) 
+
+  - Install the following .apk on your device. Please note you may need to allow external app installs on your phone 
+
+    - On non-Samsung devices:
+
+      - Go to your phone’s **Settings**.
+
+      - Go to **Security & privacy** > **More settings**.
+
+      - Tap on **Install apps from external sources**.
+
+      - Select the browser (e.g., Chrome or Firefox) you want to download the APK files from.
+        [<img src="https://sp-ao.shortpixel.ai/client/to_webp,q_lossy,ret_img,w_1340,h_602/https://s23429.pcdn.co/wp-content/uploads/2016/08/andriod-install-unknown-apps.png" alt="Select the browser you want to download the APK from. " style="zoom:50%;" />](https://s23429.pcdn.co/wp-content/uploads/2016/08/andriod-install-unknown-apps.png)
+
+      - Toggle **Allow app installs** on.
+
+        On non-Samsung devices:
+
+      1. Go to your phone’s **Settings**.
+      2. Go to **Biometrics and security** > **Install unknown apps**.
+      3. Select the browser (e.g., Chrome or Firefox) you want to download the APK files from.
+      4. Toggle **Allow app installs** on.
+
+  - Launch the app normally from your app menu like any other app ! 
+
+#### 			NOTE: Please ensure you have Android 9.0 or greater. 
+
+#### 		     For current project implementation , one MUST have a iiitb.ac.in email ID to use the app 
+
+- ### For Developement :
+
+  - Setup [Flutter environment](https://docs.flutter.dev/get-started/install) and [Android Virtual Device Manager (AVD Manager)](https://medium.com/michael-wallace/how-to-install-android-sdk-and-setup-avd-emulator-without-android-studio-aeb55c014264)
+
+  - Clone this repository 
+
+  - Open the main.dart file from lib folder
+
+  - You may need to run `$ dart pub get [options]` to load all the dependencies to run the code 
+
+    #### NOTE : AVD version used to develop was 31.0 (Tested on pixel 4, 5 AVD)
+
+
+
+### NOTE: The OTP_auth service is hosted on a test-server which allows only 30 OTP request for a single day. Also all time inputs are considered to be in 24hr format 
+
+# Contributors
+
+- Ishan Jalan - https://www.linkedin.com/in/ishaan-jalan-550a28213/
+- Karanjit Saha - https://www.linkedin.com/in/karanjit-saha-65a02122b/
+- Monjoy Narayan Choudhury - https://www.linkedin.com/in/monjoy-narayan-choudhury-a424b3200/
+- Rudransh Dixit - https://www.linkedin.com/in/rudransh-dixit-a785a61ba/
+
+
+
+# Github Repo link
+
+https://github.com/ishaanj0412/Carpool

Readme_pics/1.jpeg

@@ -1,7 +1,7 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="com.example.carpool">
    <application
-        android:label="carpool"
+        android:label="Carpool"
         android:name="${applicationName}"
         android:icon="@mipmap/ic_launcher">
         <activity