🍕 [WIP] Modern OSS Order Management System for Pizza Restaurants
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
backend
frontend fix tests Feb 17, 2019
.gitignore Better thank you message and more Jan 14, 2019
.travis.yml fix! Feb 17, 2019
LICENSE Initial commit Dec 26, 2018
diagram.png diagram Jan 5, 2019
readme.md

readme.md

PizzaQL 🍕

Modern OSS Order Management System for Pizza Restaurants.

Build Status XO code style style: styled-components

Goal

The goal of this project is to provide a modern and easy to use order management system with order placement form as well. You can track progress in our TODO list 😄

More information coming soon. Please note that this project is currently work in progress and you shouldn't use it in production!

Setup

Note: The following instructions are for developers. Setup instructions for beginners will be provided later.

Prerequisites

  1. Clone this repository
  2. Enter the backend directory
  3. Run docker-compose up -d and then prisma deploy to start the GraphQL Server
  4. Enter the frontend directory
  5. Edit the settings.js file and include your Auth0's client id & domain
  6. Run npm install to install required dependencies
  7. Now run npm run dev to start the application in the development mode
  • You can access the GraphQL Playground at http://localhost:4466/
  • You can access the order placement form at http://localhost:3000 and the admin dashboard at http://localhost:3000/admin (you will need to login to see the list of orders)
  • To build the application in the production mode, just run npm run build

TODO

Order Placement System

  • Basic Frontend
    • Production-ready Frontend (styles etc.)
    • Dark mode
  • Working Backend
    • Creating orders
  • Better delivery time selection
  • Lock order placement system between specific hours

Order Management System

  • Login
    • Full security with Auth0
  • Basic Frontend
    • Listening for orders (instead of manual page reloading)
      • Rewrite to GraphQL Subscriptions (work in progress, requires custom resolver)
    • Ability to delete orders
    • Production-ready Frontend (styles etc.)
  • Working Backend

Project Page

  • Home page
  • About page
  • Other pages (like contact form)

Other

  • Testing with Ava & Enzyme
  • Move from Prisma Cloud to Docker.
  • Documentation
  • Paid support (?)

(?) - unsure.

How it works?

Diagram

Built with:

and many other awesome technologies 🦄

License

MIT