Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muhammadsaadhsn/mentorme
MentorMe is an Android app in Kotlin, using Firebase. It connects mentees with mentors, providing real-time messaging, session booking, and community engagement. Simplifying mentorship, it's accessible and efficient for users seeking guidance or sharing expertise within Android.
https://github.com/muhammadsaadhsn/mentorme
android-application android-development androidstudio kotlin kotlin-android
Last synced: 2 days ago
JSON representation
MentorMe is an Android app in Kotlin, using Firebase. It connects mentees with mentors, providing real-time messaging, session booking, and community engagement. Simplifying mentorship, it's accessible and efficient for users seeking guidance or sharing expertise within Android.
- Host: GitHub
- URL: https://github.com/muhammadsaadhsn/mentorme
- Owner: muhammadsaadhsn
- License: mit
- Created: 2024-02-09T07:23:35.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-11T03:19:43.000Z (8 months ago)
- Last Synced: 2025-01-28T15:39:50.951Z (14 days ago)
- Topics: android-application, android-development, androidstudio, kotlin, kotlin-android
- Language: Kotlin
- Homepage:
- Size: 1.66 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MentorMe
MentorMe is an Android application developed with Firebase that aims to connect mentees with mentors across various fields. The app enables users to book sessions, browse and filter mentors, participate in community chats, and manage their profiles.
## Features
### User Authentication
- **Sign Up:** Users can create an account by providing their email, password, and personal details.
- **Login:** Users return to their existing account using their credentials.
- **Logout:** Allows users to securely exit their account.
### Profile Management
- **Profile Updates:** Users can update personal information such as their name, contact details, profile picture, and cover photo.
- **Privacy Settings:** Control who can view their profile and personal information.
### Mentor Interaction
- **Booking Sessions:** Users can book sessions with mentors based on their availability.
- **Favorites:** Users can add mentors to a favorite list for quicker access in future interactions.
- **Reviews:** After sessions, users can leave feedback on their experience with mentors.
### Community Features
- **One-to-One Chat:** Private messaging feature to communicate directly with mentors.
- **Community Chat:** Group chat rooms where users can discuss topics and share information.
### Real-Time Updates
- **Firebase Integration:** Utilizes Firebase for real-time data syncing, ensuring that all user interactions and updates are instant.
- **Notifications:** Receive push notifications for important events like session confirmations and messages.
### Enhanced Search
- **Filters:** Users can search for mentors by specialties, ratings, and availability.
- **Recent Searches:** Easily revisit previously searched terms.
### Accessibility and Offline Support
- **Accessibility:** Implements accessibility features such as text scaling and color contrast to cater to all users.
- **Offline Mode:** The app caches data locally to allow users to access and write data without an internet connection. Changes are synced once connectivity is restored.
## Installation
### Cloning the Repository
```bash
git clone https://github.com/i210566/mentorme.git
```
### Setting up in Android Studio
- Open Android Studio and select "Open an existing project", then navigate to the cloned repository.
### Configuring Firebase
- Create a Firebase project via the [Firebase Console](https://console.firebase.google.com/).
- Download the `google-services.json` file and place it in the `app/` directory to connect the app with Firebase.
### Building the Project
- Navigate to Build > Rebuild Project in Android Studio to prepare the app for running.
### Running the Application
- Select Run > Run 'app' to launch the application on an emulator or connected device.
## Project Structure
- **`/app/src/main/java/com/yourname/i210566`:** Java source files for the application's functionalities.
- **`/app/src/main/res/layout`:** XML files defining the UI of the app.
- **`/app/src/main/res/values`:** Resource files for strings, dimensions, and styling that help maintain consistency throughout the app.
## Testing
### Espresso Framework
- **Location:** `/app/src/androidTest/java/com/yourname/i210566`
- **Purpose:** Automated UI tests to ensure that critical user interactions like navigation and button clicks perform as intended.
## GitHub Integration
- **Commit Strategy:** Regular commits are made to document the development process, with each significant change or addition to the application being committed separately. This ensures a clear history and easy rollback if necessary.
## License
This project is made available under the MIT License which permits reuse, distribution, and modification.