Skip to content

Latest commit

 

History

History
86 lines (72 loc) · 3.13 KB

learn.md

File metadata and controls

86 lines (72 loc) · 3.13 KB
Raw

ResQFood

banner

LEARN ABOUT ResQFood

Technologies

  • Jetpack
    • Compose: Modern toolkit for building native UI.
    • Navigation: Navigation component for Jetpack Compose.
    • ViewModel: Store UI-related data that isn't destroyed on UI changes.
    • Room: SQLite object mapping library.
    • Paging 3: Load and display small chunks of data at a time.
  • Hilt: Dependency injection library for Android.
  • Retrofit: Type-safe HTTP client for Android and Java.
  • Coroutines: For managing background threads with simplified code and reducing needs for callbacks, with Flow.
  • Coil: Image loading library for Android backed by Kotlin Coroutines.
  • Gson: A Java serialization/deserialization library to convert Java Objects into JSON and back.

Architecture

ResQFood follows the MVVM (Model-View-ViewModel) architecture pattern, which separates the presentation layer from the business logic and data handling. This architecture pattern helps to create a modular, scalable, and testable codebase.

Get Started

  • To get started with ResQFood, follow these steps:
  1. Give a star to this repository.
  2. Fork this repository.
  3. Clone the forked repository to your local machine by typing the following command in the terminal
$ git clone https://github.com/<your-github-username>/ResQFood.git
  1. Change directory
$ cd ResQFood
  1. Add a reference(remote) to the original repository.
$ git remote add upstream https://github.com/repository_owner/repository_name.git
  1. Check the remotes for this repository.
$ git remote -v
  1. Make a pull from the upstream repository to your main branch to keep it updated as per the main project repository.
$ git pull upstream main
  1. Create a new branch for your changes.
$ git checkout -b <YOUR_BRANCH_NAME>
  1. Make your changes in the code.
  2. After making the required changes. Check your changes with
$ git status
$ git diff
  1. Stage your changes
$ git add . <\files_that_you_made_changes>
  1. Commit your changes.
$ git commit -m "relavant message"
  1. Push your changes to your forked repository.
$ git push -u origin <your_branch_name>
  1. Now to create a pull request, click on compare and pull request.
  2. Add an appropriate title and description to your PR explaining your changes.
  3. Click on Create pull request.

Contributing

We welcome contributions from the community to help improve and expand ResQFood. Whether you're a developer, designer, or passionate about our cause, we'd love to have you on board!

Support

If you have any questions, feedback, or need assistance, feel free to reach out to us at the discussion panel. We're here to help!

License

ResQFood is licensed under the MIT License.