Periodic Tables

Periodic Tables is a reservation system that will help restaurants streamline their operations by incorporating a customer, reservation, and table management web application. It allows the creation of new reservations and new tables, as well as updating them to reflect the most up-to-date statuses.
View the live demo »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Pages
4. API Documentation
5. User Stories
6. Contact

About The Project

(back to top)

Built With

• React.js
• Bootstrap
• Node.js
• Knex.js
• Express
• PostgreSQL
• Swagger
• Swagger UI

(back to top)

Getting Started

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

Installation

1. Clone the repo

   git clone https://github.com/PhamJimmy/restaurant-reservation-system.git

2. Install NPM packages

   npm install

3. Copy the .env.sample file and make a .env file
4. Fill in environment variables
5. Run the app

   npm start

(back to top)

Pages

Dashboard

The main page showing the day's reservations and all the table statuses.

Search

Entering in a phone number will search the database for any matches regardless of reservation status.

New Reservation

The form to create a new reservation which will be assigned a new reservation_id.

New Table

The form to create a new table which will be assigned a new table_id.

(back to top)

API Documentation

See the API Documentation for a breakdown of the endpoints. The documentation (via Swagger API) will be deprecated soon once Heroku's free hosting tier changes.

(back to top)

User Stories

See the Trello Board for a full list of the original proposed features.

(back to top)

Contact

Jimmy Pham - LinkedIn - JimmyPhamRes@gmail.com

Project Link: https://github.com/PhamJimmy/restaurant-reservation-system

(back to top)