Project-Easter/Flutter-UI

Hacktober

Explr

App Logo

github-profile-readme-generator license github-profile-readme-generator forks github-profile-readme-generator stars github-profile-readme-generator issues github-profile-readme-generator pull-requests GitHub closed pull requests

---

The project is for all book lovers who want to find other book lovers to either exchange books, discuss about books or get to know people who have similar preference when it comes to reading.

📝 Table of Contents

• 📝 Table of Contents
• 🎯 Aim
• 💥 Screenshots (Old)
• ⛏️ Built With
• 🍰 How to contribute
• 📜 Important Guidelines
• 🙋‍♂️ Discussion
• 🎈 1st Release Features
• 🚩 Further Project Details
• ⚡ Flutter Resources
• 🙏 Show your support

🎯 Aim

• Our project aims at providing a platform for users where they can know what their friends are reading and exchange books with them, along with knowing which book is the talk of the town, and we mean it literally.
• Our project will provide users the service of knowing what is the most read and exchanged books in their desired radius. This is what we mean by knowing what is the talk of the town.
• In the future, we want our project to be used by people ranging from hardcore bibliophiles searching for a book they want to read in their locality to university students searching for other students for exchanging their course books.
• Our horizon is not limited as we want to reach each and every one.

💥 Screenshots (Old)

https://user-images.githubusercontent.com/59333817/111777617-88d6ee80-88d9-11eb-994b-ecea2fc9b01c.jpeg https://user-images.githubusercontent.com/59333817/111777662-97bda100-88d9-11eb-930a-2566fede248a.jpeg https://user-images.githubusercontent.com/59333817/111777996-0ac71780-88da-11eb-947e-2ec0d4bc562b.jpeg

https://user-images.githubusercontent.com/59333817/111780909-0ac91680-88de-11eb-8761-58046afdaec8.jpeg https://user-images.githubusercontent.com/59333817/111781130-2df3c600-88de-11eb-99f7-d08f2210c920.jpeg https://user-images.githubusercontent.com/59333817/111780924-10bef780-88de-11eb-840e-c4b8f7fad08d.jpeg

https://user-images.githubusercontent.com/59333817/111782093-a35f9680-88de-11eb-935f-9836d7b3e89c.jpeg https://user-images.githubusercontent.com/59333817/111782106-a65a8700-88de-11eb-94fa-52725570dbdb.jpeg https://user-images.githubusercontent.com/59333817/111782207-c4c08280-88de-11eb-8c00-aece1493431b.jpeg

⛏️ Built With

• Flutter
• Dart
• Firebase
• REST API

🍰 How to contribute

Step 1: Fork this repository

• A fork will create a copy of this repository in your GitHub account. fork howto

Step 2: Clone the repository

• Cloning will create the copy of the forked repository in your local machine.

• Copy the URL from here. clone

• Open Git Bash or terminal and run the following command:

git clone https://github.com/<Your GitHub Username>/Flutter-UI.git

• After cloning the repo, run this command to add the main repository as upstream to sync with it. Run this command to add upstream:

git remote add upstream https://github.com/Project-Easter/Flutter-UI.git

Step 3: Create a branch:

• Creating your own branch separates your changes with main branch. For example, if things go wrong or you are not satisfied with them, then you can delete your branch and the main project won't be affected.

Navigate to the folder where the repository is cloned, which will be named Flutter-UI.

Now, in the terminal, create a branch in Git using the following command:

git checkout -b <explr/your-first-name>

Use the same name in the branch created in GitHub.

Step 4: Make necessary changes and commit

1. Open the project in Android Studio or VS Code(recommended) and make sure that you are on the branch created by you, not on main.
2. Make the changes on the concerned files in order to implement a feature you want to add or resolve an issue.
3. After you are satisfied with your changes, you can add these changes by using the command:

git add <file names>

4. Pull the changes from the upstream repo using the command:

git pull upstream main

5. Then commit these changes using the command:

git commit -m'<Relevant commit message>'

Step 5: Push changes

Push your changes using the command:

git push origin <explr/your-first-name>

Step 6: Make a Pull request

Go to your forked GitHub repository, you will see a Compare & pull request button. Click on it. make pr

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us as mentioned above.

📜 Important Guidelines

• Use latest Flutter version 2.5 before forking the repository.
• Comment on the issue you want to work, tagging me (@Mohitmadhav) or Ankit (@ankitoscar).
• Then only you'll be assigned with the issues and your PRs will be considered.
• Create you branches with branchname explr/your-first-name only in your forked repository.
• You can only work on one issue at a time.
• Any changes in the documentation will be marked as invalid or spam
• Do not make any changes in the main branch or the original repository.
• Refrain to make the pull requests without getting an issue assigned.
• Follow the given pull request template properly.
• Always do git pull upstream main before pushing any changes in your branch.
• Please follow the linting rules and standard practices as specified in analysis_option.yaml to avoid unnecessary warnings

PS: Feel free to share your ideas and opening issues for new bugs or features 😇. Just make sure that you don't put any labels on it or assign it to yourself or anyone. Tag us(@Mohitmadhav and @ankitoscar) in your issue, we will reach out to your issues and assign it to you with proper labels.

🙋‍♂️ Discussion

You can participate in our discussions at Github Discussions which has the following topics:

1. Welcome : Here you can introduce yourself and get a basic idea about the project from maintainers and contributors.

2. Code Refactoring : Here you can share ideas about refactoring and adding modularity in the codebase and also mention where these changes cahn be done.

🎈 1st Release Features

Features to be implemented:

• Facebook/Email Authentication
• User Library (Owned/Saved/Borrowed Books)
• Firebase Chat
• Getting nearby books (Within 10 km)
• Dashboard Book Recommendations

🚩 Further Project Details

• Design (Might get changed in future)
• Presentation

⚡ Flutter Resources

• Lab: Write your first Flutter app
• Cookbook: Useful Flutter samples
• Flutter Documentation

🙏 Show your support

⭐️ this repository if you liked our work!