Free Lunch App

Table of Contents

• Free Lunch App
  • Table of Contents
  • Introduction
  • Features
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
  • App Screenshots
  • Test
  • Contributing
  • License

Introduction

The Free Lunch App is a Flutter-based mobile application that connects generous individuals offering free meals with those in need. This README provides an overview of the app, how to use it, and how to contribute to its development.

Features

• Gifting free lunches to Co-workers
• Redeeming free lunches
• Get Notified about lunches and App Update
• Reporting issues

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Flutter SDK installed on your development machine. If not, follow the Flutter installation guide.
• A compatible Android or iOS device or an emulator/simulator.

Installation

1. Clone the repository:

   git clone https://github.com/hngx-org/Empire-food-mobile.git

2. Navigate to the project directory:

   cd free_lunch_app

3. Install dependencies:

   flutter pub get

Usage

1. Start the app on your emulator/simulator or a physical device:

   flutter run

2. Follow the on-screen instructions to register or log in and start using the app.

App Screenshots

Test

https://appetize.io/app/zkntdn2cyqaj42asqhjjq3w5dm

Contributing

Contributions are welcome! If you'd like to contribute to the Free Lunch App, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name.
3. Make your changes and commit them: git commit -m 'Add new feature'.
4. Push your changes to your fork: git push origin feature/your-feature-name.
5. Create a pull request against the main branch of the original repository.

License

This project is licensed under the MIT License.