Skip to content

MEROO1010/coffee-land

Repository files navigation

coffee_land β˜•

πŸ“Œ Getting Started

Coffee Land is a cross-platform mobile application developed using Flutter, designed to provide users with a seamless coffee ordering experience. This project brings to life a UI/UX design previously showcased on Behance, emphasizing intuitive navigation and aesthetic appeal.

Design Inspiration

The application's design is based on a concept previously created and shared on Behance. You can view the original design here:

πŸ‘‰ Coffee Land App Design on Behance

https://www.behance.net/gallery/149167533/Coffee-Land-App-design

πŸ“Œ The mouckup

mouckup coffeeland

πŸ“ŒThe preview of the app πŸ‘‡

Android.Emulator.-.pixel_2_xl_-_api_30_5556.2023-01-01.05-18-30.online-video-cutter.com.mp4

πŸš€ Features

User-Friendly Interface: Navigate through a clean and intuitive UI. Menu Browsing: Explore a variety of coffee options with detailed descriptions. Order Customization: Customize your coffee orders to your preference. Cart Management: Add, remove, and modify items in your cart seamlessly. Order Tracking: Monitor the status of your orders in real-time.

πŸ› οΈ Tech Stack

Frontend: Flutter (Dart) Backend: Django (Python) State Management: Provider Database: SQLite (Local), PostgreSQL (Production) Authentication: Firebase Auth APIs: RESTful APIs developed using Django REST Framework

πŸ“ Project Structure

coffee-land/ β”œβ”€β”€ android/ β”œβ”€β”€ assets/ β”‚ └── images/ β”œβ”€β”€ backend_django/ β”œβ”€β”€ ios/ β”œβ”€β”€ lib/ β”‚ β”œβ”€β”€ models/ β”‚ β”œβ”€β”€ screens/ β”‚ β”œβ”€β”€ widgets/ β”‚ └── main.dart β”œβ”€β”€ test/ β”œβ”€β”€ pubspec.yaml └── README.md

πŸ§‘β€πŸ’» Getting Started

Prerequisites Flutter SDK: Install Flutter Python 3.x Django: Install via pip install django Firebase Account: Firebase Console

Installation

  1. Clone the Repository git clone https://github.com/MEROO1010/coffee-land.git cd coffee-land

  2. Install Flutter Dependencies

flutter pub get

  1. Set Up the Backend Navigate to the backend_django directory and install the required Python packages: cd backend_django pip install -r requirements.txt

Apply migrations and start the Django development server: python manage.py migrate python manage.py runserver

  1. Run the Flutter App

Navigate back to the root directory and run the app:

flutter run

πŸ§ͺ Testing

 To run the unit tests for the Flutter application:

    flutter test

Ensure that the backend server is running before executing integration tests.

🀝 Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.

  2. Create a new branch: git checkout -b feature/YourFeature

  3. Commit your changes: git commit -m "Add YourFeature"

  4. Push to the branch:

    git push origin feature/YourFeature

  5. Open a pull request.

πŸ“„ License

This project is licensed under the MIT License. See the LICENSE file for details.