Welcome to littleLemon, your go-to app for browsing menus and discovering delicious dishes! This README will guide you through the features, setup, and usage of the app.
-
Menu Fetching: littleLemon utilizes Ktor to fetch menus from the backend server. This ensures that you always have access to the latest menu items from your favorite restaurants.
-
Menu Search: Easily search through the menu items to find exactly what you're craving. Whether it's a specific dish or cuisine, littleLemon makes it simple to discover new culinary delights.
-
Offline Access: Thanks to Room Database integration, littleLemon allows you to save menus for offline use. Even when you're without an internet connection, you can still access previously browsed menus and favorite dishes.
To get started with littleLemon, follow these steps:
-
Clone the Repository: Clone the littleLemon repository to your local machine using Git.
-
Backend Configuration: Ensure that the backend server is up and running. Modify the necessary configuration files to connect to the correct backend URL if needed.
-
Android Studio: Open the project in Android Studio.
-
Run the App: Build and run the littleLemon app on your Android device or emulator.
Once the app is up and running, you can explore its features:
-
Browsing Menus: Browse through the available menus by selecting restaurants or categories.
-
Search: Use the search functionality to quickly find specific dishes or cuisines.
-
Offline Access: Enjoy offline access to previously viewed menus and favorite dishes by enabling offline mode in the settings.
-
Saving Favorites: Save your favorite dishes for quick access later.
-
Updating Menus: Pull down to refresh to fetch the latest menus from the backend server.
-
Settings: Customize your littleLemon experience through the settings menu, where you can adjust preferences such as offline mode and notification settings.
We welcome contributions to littleLemon! If you'd like to contribute new features, enhancements, or bug fixes, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure all tests pass.
- Commit your changes with clear commit messages.
- Push your changes to your fork.
- Open a pull request, detailing the changes you've made and any relevant information.
We value your feedback! If you encounter any issues, have suggestions for improvements, or just want to share your thoughts on littleLemon, please don't hesitate to reach out. You can submit an issue on GitHub or contact us directly through email.
littleLemon is licensed under the [insert license type here]. See the LICENSE file for more details.
Thank you for choosing littleLemon! We hope you enjoy exploring menus and discovering delicious dishes with our app.