Project Title: Resy Bot

Collaborators

Mark Lung (github), Zack Goldberg(github), Aditya Pradeep(github) ,Geoffrey Budiman (github), Rayhan Ahmed (github)

Vision Statement

Resy Bot aims to obtain reservations at popular and hard to get into restaurants. As NYC continues to open up post-pandemic, popular restaurants are harder to get reservations at, but with Resy Bot, you are able to get a reservation at any restaurant of your liking! For whoever wants to get a reservation at a restaurant of their choosing. Web app where you can select a restaurant and timing(s) of when you want to go. Resy Bot will then wait for the reservation to be open and snipe it instantly, then will email or send a text message regarding the reservation.

Contributing

For more info on contribution visit CONTRIBUTING.md

Building and Running

1. Fork this repository
2. Clone your fork of this repository to your local machine
3. Navigate into the project directory

Build and launch the back end

1. Navigate into the back-end directory
2. Run npm install to install all dependencies listed in the package.json file
3. Make sure to create an .env file and copy the contents of .env.example into it
4. Run npm start to launch the Express.js server

Build and launch the front end

1. Navigate into the front-end directory
2. Run npm install to install all dependencies listed in the package.json file, Make sure the proxy setting in the json file specifies the right domain:

"proxy": "http://localhost:3001"

1. Run npm start to launch the React.js server

Additional Links

UX-DESIGN

1. See the Sprint Planning instructions for the requirements of Sprint Planning for each Sprint.

2. See the Front-End Development instructions for the requirements of the initial Front-End Development.

3. See the Back-End Development instructions for the requirements of the initial Back-End Development.

4. See the Database Integration instructions for the requirements of integrating a database into the back-end.

5. See the Deployment instructions for the requirements of deploying an app.