Explr

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.

/Flutter-UI.git ``` * After cloning the repo, run this command to add the [main repository](https://github.com/Project-Easter/Flutter-UI.git) 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 ``` 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 ``` 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'' ``` **Step 5: Push changes** Push your changes using the command: ``` git push origin ``` **Step 6: Make a Pull request** Go to your forked GitHub repository, you will see a *Compare & pull request* button. Click on it. Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), 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`](analysis_options.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**](https://github.com/Project-Easter/Flutter-UI/discussions/90) : Here you can introduce yourself and get a basic idea about the project from maintainers and contributors. 2. [**Code Refactoring**](https://github.com/Project-Easter/Flutter-UI/discussions/91) : 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)](https://www.figma.com/file/uhWQuE4EKDHR8AqH4p3eFK/Books-App?node-id=0%3A1) * [Presentation](https://docs.google.com/presentation/d/1JixGIcBdiv_HLNc6sxt516U3mi4K08a_/edit#slide=id.p5) ## ⚡ Flutter Resources * [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab) * [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook) * [Flutter Documentation](https://flutter.dev/docs) ## 🙏 Show your support ⭐️ this repository if you liked our work!