https://github.com/mjbeaumont/mealcloud-portal

Back end prototype of an online ordering app, meant to be embedded inside an existing website design.
https://github.com/mjbeaumont/mealcloud-portal

composer database minimum yii

Last synced: about 2 months ago
JSON representation

Back end prototype of an online ordering app, meant to be embedded inside an existing website design.

• Host: GitHub
• URL: https://github.com/mjbeaumont/mealcloud-portal
• Owner: mjbeaumont
• License: bsd-3-clause
• Created: 2020-06-18T15:48:54.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-31T02:48:37.000Z (over 1 year ago)
• Last Synced: 2024-04-24T11:32:16.815Z (5 months ago)
• Topics: composer, database, minimum, yii
• Language: PHP
• Homepage: https://mealcloud-portal.beaumontwebdev.com
• Size: 229 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Restaurant Ordering App

## Introduction

This is the back end code for a prototype of a re-usable restaurant ordering app. The front end can be found [here](https://www.github.com/mjbeaumont/mealcloud-demo). 

This was used to pitch the idea of a re-usable ordering platform that could embedded in the overall design of a restaurant's website to allow them to accept online orders quickly, and was created in under a month. It is a WIP.

Please see [TODO](#TODO) for important notes.

See [DEMO](https://mealcloud-portal.beaumontwebdev.com) 

## Technologies Used

* Yii Framework 2

* Composer

* Stripe PHP SDK

* DotENV

## Features

1. Exposes API to accept orders from front end app.

2. Allows creation of multiple users

3. Users can manage order status

4. Orders submit to a backend portal (see above) where they are stored for processing.

## API

See description of endpoints [here](api.md)

## Installation

````

composer install

````

Create a MySQL database. Copy .env.example to .env and fill in your database credentials. Then run:

````

./yii migrate

````

You will also need a Stripe test API key, and you should enter all possible domains where orders can be submitted in order to configure the CORS response of the API.

## TODO

1. For purposes of this demo, the menu and cart totals are being provided by the frontend. We would NEVER do this in real life, so all of this functionality should be moved into this repo.

1. Add Unit/E2E tests