RelaxBook is a Flutter project that replicates the design and features of Facebook, and it is open for contributions. This project aims to provide a platform for developers to learn and contribute to a real-world Flutter application.
-
Authentication: Sign in and sign up functionality using Firebase Authentication.
-
News Feed: View posts from friends and follow users, like and comment on posts.
-
Profile: View and edit your profile, including profile picture and bio.
-
Friend Requests: Send and accept friend requests, manage your friends list.
-
Chat: Real-time messaging with friends.
-
Notifications: Stay updated with likes, comments, and friend requests.
-
Explore: Discover new content and users to follow.
-
Dark Mode: An option for dark mode for a more comfortable browsing experience.
To get started with contributing to RelaxBook, follow these steps:
-
Fork the repository and clone it to your local machine.
-
Install Flutter and Dart: Make sure you have Flutter and Dart installed. If not, follow the official Flutter installation guide: https://flutter.dev/docs/get-started/install
-
Firebase Configuration: Set up a Firebase project for authentication and real-time database functionality. Add the necessary Firebase configuration to the project.
-
Run the App: Run the app locally with
flutter run
. -
Pick an Issue: Check the issues section for tasks and features to work on.
-
Create a Branch: Create a new branch for your feature or bug fix using
git checkout -b your-branch-name
. -
Make Changes: Write your code and make the desired changes.
-
Test: Make sure your changes work as expected and do not introduce new issues.
-
Commit and Push: Commit your changes and push to your forked repository.
-
Create a Pull Request: Create a pull request from your branch to the
main
branch of the original RelaxBook repository.
-
Follow the coding style and guidelines used in the project.
-
Write clear and concise commit messages.
-
Comment your code when necessary.
-
Be responsive to feedback and communicate with other contributors.
-
Test your changes thoroughly before submitting a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
-
This project is inspired by the design and features of Facebook.
-
Thanks to the Flutter and open-source community for their contributions and support.
Happy coding and contributing to RelaxBook!