/Milky-Wayy

Primary LanguageKotlin

Milky-Wayy

Milky-Wayy is an Android app developed in Kotlin that facilitates the delivery of milk and other products. It incorporates fingerprint authorization for enhanced security and provides consumers and vendors with an easy way to keep track of their records and orders.

Features

  • User Registration: Users can create accounts with their personal information, such as name, address, and contact details.

  • Fingerprint Authorization: The app utilizes the device's fingerprint sensor for secure authentication and authorization.

  • Product Catalog: The app provides a comprehensive catalog of milk and other products available for delivery.

  • Order Placement: Users can browse through the catalog, select the desired products, and place orders for home delivery.

  • Order History: Users can view their order history, including details of past orders, delivery status, and payment information.

  • Vendor Management: Vendors can manage their inventory, update product details, and track orders.

Requirements

To run Milky-Wayy on your local machine, ensure that you have the following:

  • Android Studio (version 4.2 or later)
  • Kotlin (version 1.5 or later)
  • Android SDK (minimum SDK version 21)

Installation

  1. Clone the Milky-Wayy repository to your local machine using Git or download the source code as a ZIP file.
git clone https://github.com/your-username/Milky-Wayy.git

  1. Launch Android Studio and select "Open an existing Android Studio project."

  2. Navigate to the cloned Milky-Wayy directory and select the build.gradle file within it.

  3. Android Studio will sync the project and download any necessary dependencies.

  4. Connect an Android device to your machine or set up an emulator using the AVD Manager in Android Studio.

  5. Build and run the Milky-Wayy app on your device or emulator.

Usage

Upon launching the Milky-Wayy app, follow these steps:

  1. Register a new user account by providing the required personal details.

  2. Authenticate using your fingerprint to access the main features of the app.

  3. Browse through the product catalog to view available items for delivery.

  4. Select the desired products and add them to your cart.

  5. Proceed to the checkout and provide the delivery address and payment details.

  6. Confirm your order, and the app will display the order confirmation along with the estimated delivery time.

  7. Vendors can log in to their accounts and manage their inventory, update product details, and track incoming orders.

Contributing

Contributions to Milky-Wayy are welcome! If you want to contribute to the project, follow these steps:

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine.

  3. Create a new branch for your feature or bug fix.

  4. Make the necessary changes and commit them.

  5. Push your changes to your forked repository.

  6. Submit a pull request to the original Milky-Wayy repository.

Please ensure that your contributions align with the project's coding style and guidelines.

License

Milky-Wayy is open-source software released under the MIT License. Feel free to modify and distribute the codebase as per the terms of the license.

Contact

If you have any questions, suggestions, or feedback regarding Milky-Wayy, please contact Utkarsh Kumar, or feel free to raise an Issue!

Happy delivering with Milky-Wayy!