Greetings everyone! I'm pleased to introduce GuruDealer. What is GuruDealer? It's an open-source mobile application primarily created with Kotlin, XML, Firebase, among other libraries!
-
Clone the Repository:
- Open your terminal or command prompt.
- Navigate to the directory where you want to clone the project.
- Run the following command:
git clone https://github.com/jamirou/GuruDealer.git
-
Replace API Keys:
- Navigate to the project directory.
- Locate the
strings.xml
file in theres/values
directory. - Replace
"YOUR_API_KEY"
with your own API key. - Additionally, in the
Constants.java
orConstants.kt
file, replace"FCM_SERVER_KEY"
with your Firebase Cloud Messaging (FCM) server key.
-
Build and Run:
- Once you've replaced the API keys and installed any necessary dependencies, you can build and run the project using your preferred IDE or build tool.
Below is a list of the technologies and dependencies used in the project:
Technology/Dependency | Version |
---|---|
Kotlin | |
XML | |
Firebase | |
AndroidX Core KTX | 1.9.0 |
AndroidX AppCompat | 1.6.1 |
AndroidX ConstraintLayout | 2.1.4 |
Firebase Firestore | 24.10.0 |
JUnit | 4.13.2 |
AndroidX Test Ext | 1.1.5 |
Espresso Core | 3.5.1 |
Material Design Components | 1.10.0 |
Firebase BoM | 32.6.0 |
Firebase Analytics | |
Firebase Authentication | |
Firebase Realtime Database | |
Google Play Services Auth | 20.7.0 |
Glide | 4.16.0 |
Country Code Picker (CCP) | 2.7.0 |
Firebase Cloud Storage | |
Google Maps SDK for Android | 18.2.0 |
Google Places API | 3.3.0 |
BaseFlow PhotoViewer | 2.3.0 |
Firebase Cloud Messaging | 23.4.0 |
Google Ads SDK | 22.5.0 |
- MVVM Architecture: Meticulously implemented for organized and maintainable code.
- User-Centric Experience: Every detail designed for user comfort and fluidity.
- Flexible Registration Options: From easy email registration to using your Google account.
- Ad Functionality: Integrated for those looking to monetize their applications.
- Free for Users: Completely free for users.
If you wish to contribute to the project, follow these guidelines:
-
Fork the Repository:
- Click on the "Fork" button at the top right corner of the repository page. This will create a copy of the project in your GitHub account.
-
Clone Your Fork:
- Follow the same cloning instructions as above, but clone your forked repository instead.
-
Create a New Branch:
- Before making any changes, create a new branch for your feature or bug fix:
git checkout -b feature-name
- Before making any changes, create a new branch for your feature or bug fix:
-
Make Changes:
- Make your desired changes to the codebase.
-
Commit Changes:
- Once you've made your changes, commit them to your branch:
git add . git commit -m "Your descriptive commit message"
- Once you've made your changes, commit them to your branch:
-
Push Changes:
- Push your changes to your forked repository:
git push origin feature-name
- Push your changes to your forked repository:
-
Create a Pull Request:
- Go to your forked repository on GitHub.
- Click on the "New Pull Request" button.
- Follow the instructions to create a pull request. Be sure to provide a clear description of your changes.
That's it! Your contribution will be reviewed by @Jamirou. Thank you for your interest in collaborating! Feel free to ask any questions or share your feedback by opening issues or pull requests. I appreciate your input!