EscapeMe

Description

A customizable booking system initially designed for escape room businesses. Scalable for other business types.

Table Of Contents

• Installation
• Usage
• Technologies
• Demo
• Screenshots
• Questions
  

Installation

Follow the steps below to install this project:

1. Clone this repo to your local machine
2. Open a terminal and navigate to the root of the project's directory
3. Type npm run install and press enter/return on your keyboard to run the command. This will install all needed dependencies.
4. Once the installation finishes, type and run npm run develop. This starts the server and runs the react app. Refer to package.json file in the root for more scripts.

Usage

Users are required to login in order to create a booking.
Create an account or use this dummy account to log in for user access:

Email: [email protected]
Password: test12345

Users must choose the escape room, number of players, date, and time to successfully create a booking. As users create bookings, the booked time slots will become unavailable as expected. If a user cancels a booking, the time slots will be available again. For this project example, I've chosen the business hours to be between 12pm and 8pm. Users can book an escape room every hour between the hours of 12pm and 8pm.

Technologies

The following technologies were used to develop EscapeMe:

Languages

• JavaScript
• Html
• Css

Libraries & Frameworks

• React
• Tailwind CSS
• Express
• GraphQL
• Apollo Client & Apollo Server

Database

• MySQL
• Sequelize ORM

Other Tools

• Node.js
• bcrypt
• JWT
• dotenv
• react-google-maps/api
• Day.js
• EmailJS
• React Slick

Demo

https://escapeme-62de0a91bfcf.herokuapp.com/

Screenshots

Questions

If you have any questions about this project, please contact the project owner by visiting his GitHub profile below.

Omar Zumaya
https://github.com/Omar4589