Welcome to the Suchna Walla Android application repository! Suchna Walla is an online notice board type application designed to provide students with easy access to notices, allowing them to interact with notices, comment on them, update their profiles, and customize settings. This readme will guide you through setting up the project and understanding its features.
Check out the screenshots folder to see the visuals of the application.
- User Authentication using Firebase Auth
- Real-time Notice Management with Firestore Database
- Notice Reaction and Commenting
- User Profile Management
- Settings Customization
Follow these steps to set up the project on your local machine and integrate it with your Firebase account:
- Android Studio (latest version recommended)
- Firebase Account (for setting up authentication and database)
-
Clone the repository:
git clone https://github.com/your-username/suchna-walla.git
-
Open the Project in Android Studio:
Open Android Studio and select "Open an existing Android Studio project." Navigate to the cloned repository's directory and open the project.
-
Firebase Setup:
- Create a new project on the Firebase Console.
- In the Firebase project, set up Firebase Authentication for email/password sign-in method.
- Set up Firestore Database to store notices and user data.
-
Integrate Firebase Configuration:
Open the
app
module'sbuild.gradle
file and add your Firebase configuration:dependencies { // ... implementation 'com.google.firebase:firebase-auth:20.0.1' implementation 'com.google.firebase:firebase-firestore:23.0.1' // ... }
Add your Firebase SDK configuration to the
AndroidManifest.xml
file within the<application>
tag:<meta-data android:name="com.google.firebase.messaging.default_notification_channel_id" android:value="@string/default_notification_channel_id" /> <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/ic_notification" /> <!-- Add other Firebase config here -->
-
Run the Application:
Build and run the application on an emulator or a physical device.
Feel free to contribute to the project by submitting issues and pull requests. Your contributions are highly appreciated!
This project is licensed under the MIT License.
Thank you for using Suchna Walla! If you have any questions or need further assistance, don't hesitate to contact us.