Skip to content

aziddy/OrderTogetherApp

Repository files navigation

OrderTogether

A real-time collaborative restaurant ordering web app that helps groups coordinate their orders seamlessly.

Demo

Features

  • Create and join dining sessions with unique, human-readable codes
  • Real-time collaborative order list
  • Add, edit, and remove items from the shared order
  • See who ordered what in real-time
  • Easy-to-share session URLs
  • QR code for quick session joining

Tech Stack

  • Frontend: React with TypeScript
  • Backend: Node.js with Express
  • Real-time Communication: WebSocket
  • UI Framework: Chakra UI

Run Locally On Host

Backend

cd backend
npm install
npm start

Frontend

cd frontend
npm install
npm start

The app will be available at http://localhost:3000, and the backend will run on http://localhost:5001.


Run Locally with Docker Compose and HTTPS / WSS

1) Generate Self-Signed SSL Certificates (from project root) [must have mkcert installed]

mkcert -key-file certs/localhost-key.pem -cert-file certs/localhost.pem 'localhost'

2) Start Up Docker Containers (from project root)[must have docker installed]

Frontend will be available at https://localhost:8150

docker compose -f dev-docker-compose.yml up --build # Rebuilds Images if you make changes to the containers

Tip: Stop Docker Containers

docker compose -f dev-docker-compose.yml down # Stops/Removes Containers

About

OrderTogetherApp is a WebSocket-enabled web app designed for groups dining together at sit-down restaurants. It lets friends and family collaboratively create a unified order list in real time, ensuring everyone is on the same page when the waiter arrives. Perfect for hassle-free group ordering!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors