Skip to content
Dmitry Olegovich Sorokin (@sorydima) edited this page Dec 22, 2024 · 1 revision

Getting Started

Follow these steps to set up the Nastasia Food Customer project on your local machine.


Prerequisites

Ensure you have the following installed:


Installation

  1. Clone the repository:
    git clone https://github.com/Nastasia-Food/customer.git
  2. Navigate to the project folder:
    cd customer
  3. Fetch dependencies:
    flutter pub get
  4. Run the application:
    flutter run

Features

The Nastasia Food Customer application offers the following:

  1. Customer Management
    • Add, update, and delete customer profiles.
  2. Order Tracking
    • View and manage customer orders in real-time.
  3. Notifications
    • Receive updates and promotional alerts.
  4. Cross-Platform Support
    • Seamless functionality on Android, iOS, and the web.

Explore the Architecture section to understand how these features are implemented.

Contributing Guidelines

We appreciate your interest in contributing to the Nastasia Food Customer project!


Steps to Contribute

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-name
  3. Make your changes and commit them:
    git commit -m "Describe your changes"
  4. Push your branch:
    git push origin feature-name
  5. Open a Pull Request for review.

For more details, check the CONTRIBUTING.md file.

Architecture

The Nastasia Food Customer application is built using Flutter and follows a modular structure.


Folder Structure

lib/
├── models/        # Data models
├── screens/       # UI screens
├── widgets/       # Reusable components
├── services/      # Backend integrations
assets/
├── images/        # App images
├── fonts/         # Custom fonts

Each module is designed to be reusable and maintainable.

FAQ

Q1: What platforms are supported?

The application runs on Android, iOS, and the web.

Q2: How can I report an issue?

Please create an issue in the GitHub Issues tab.

Q3: How do I integrate other Nastasia Food services?

Refer to the documentation provided in the services/ directory for details on integration.

Nastasia Food Customer Wiki

Welcome to the Nastasia Food Customer Wiki! This space contains all the information you need to get started and contribute effectively.


Quick Links


For more details, refer to the README file in the repository.