Skip to content

Latest commit

 

History

History
105 lines (82 loc) · 2.76 KB

README.md

File metadata and controls

105 lines (82 loc) · 2.76 KB
Raw

OrderMe

OrderMe is a cross-platform application that allows users to order drinks at the table when they come to a bar. The app is built using React and the Ionic framework, with Firebase for database and authentication.

Ionic Framework Firebase

Table of Contents

Features

  • User authentication (login/registration)
  • QR code scanning for table identification and menu access
  • Order drinks directly from your table
  • Filtering drinks by category
  • Searching for specific drinks
  • Real-time order updates
  • In-app payment processing
  • Viewing and downloading the receipt
  • Order history overview

Requirements

Node.js version: v20.13.1

Installation

To get a local copy up and running follow these steps:

  1. Clone the repository 
    git clone https://github.com/SinanovicEdis/OrderMe.git
  2. Navigate to the project directory 
    cd OrderMe
  3. Install the dependencies 
    npm install
  4. Start the development server 
    npm start

Usage

  1. Open the app in your browser.
  2. Sign up or log in using your credentials.
  3. Scan the QR code at your table to start ordering.
  4. Select your desired drinks and place the order.
  5. Track your order status in real-time.

Building for Mobile

To build the app for mobile platforms, follow these steps:

  1. Install the Ionic CLI 
    npm install -g @ionic/cli
  2. Add the desired platform (iOS or Android) 
    ionic cap add ios
ionic cap add android
  3. Build the app 
    ionic build
ionic cap copy
ionic cap sync
  4. Open the project in the respective IDE (Xcode for iOS, Android Studio for Android) 
    ionic cap open ios
ionic cap open android

Contributing

Contributions are what make the open-source community such an amazing place to be, learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Edis Sinanovic - edis.sinanovic1@student.um.si