devansh-299/LunchBox

Android application to provide necessary information about nearby restaurants

Build Status

LunchBox is a native Android application for exploring eateries. LunchBox provides all the details about restaurants ranging from their location to their menu and what not! The application follows MVVM architecture, written in Java and uses two back-end services:

• Zomato APIs: Documentation
• LunchBox Backend: GitHub Repository

This project is being worked under the Technology Incubator Programme BITS Pilani Goa Campus.

Gallery

Setup Screen	Home Screen	Restaurant - Gallery

Restaurant - Details	WebView - Menu	Search Screen

Building The Code

1. Clone the repository using HTTP: https://github.com/devansh-299/LunchBox.git
2. Open Android Studio.
3. Click on 'Open an existing Android Studio project'
4. Browse to the directory where you cloned the project and click OK.
5. Let Android Studio import the project and you are good to go!

Contribution Guidelines

1. All issues should be raised via GitHub issue tracker and should follow the issue template
2. All changes should be proposed via Pull Requests and should follow the pull request template
3. Commit messages should be appropriate and must reflect/describe the changes made
4. One commit should have only one change although it may involve changes in multiple files

How To Contribute

1. Fork the project
2. Make your changes and push the changes to your forked repository
3. Send a pull-request dev branch and ensure the pull request follows the template.
4. At the moment we are adding all the new features to the dev branch, and pushing only fully features to our master branch.

Documentation

• Language: Java
• Architecture: Model View ViewModel (MVVM)
• Libraries: Retrofit, RxJava, LiveData, ViewModel, Navigation Components, Material Components, ShimmerRecyclerView, Glide, Lottie-Android

Maintainer

• Devansh Aggarwal