Creating an online community for catering and ordering businesses within one online platform, Reservo!
Welcome to the Reservo README! This document offers an overview of our online reservation system's features and setup instructions. This guide will help you get started whether you're a developer looking to incorporate this platform into your website or a user interested in making reservations. This project will entail the details of the following functionalities:
- Create an online reservation and e-commerce platform for any businesses in the food industry
- Create a customizable online vendor page for businesses to display themselves
- Automate an organization system for businesses to manage and organize their inventory and workers
- Manage and track reservation statistics and information for businesses to view
- Enable google account login within the website
- [Deliverables]
- UI Style Guide
This project was bootstrapped with Create React App.
- Clone the project in any local directory you like Example using the git CLI
git clone https://github.com/EXEcuted-tech/reservo-web.git
- CD into the root folder
cd reservo-web
- Install dependencies
npm install
- Run the project
npm start
Bellow are some more detals about NPM scripts and commands
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
- ⚠ Please check the
Reviewsection below ⚠
- Start your local front-end serve
npm start
- Make sure to that your XAMPP with the imported database and mySQL server is running as well
// TODO: Add commands here
src\assets- This is where you place images (.png, .svg, etc...)src\components- Common components to be used throughout the application, you usually don't wanna touch this foldersrc\pages- Pages of the websitesrc\constants- Global variablessrc\common- Where common utils, style, and colors are compiled and accessed
Example for #6:
src
|__modules
|__reservation
|__ index.js - Entry point for the reservation module
|__ style.js - Style import for the page
- When you clone the repository, make sure you are in the
mainbranch. You can check by running this command:
git status
Expected output would be:
On branch main
Your branch is up to date with 'origin/main'.
nothing to commit, working tree clean
2.Pull the latest changes
git pull
- When you have finished adding your changes, create a branch using the
Card Numberon your assigned task in Trello
Example for #3:
//1. Create Branch using the command bellow
$ git branch ticket-12
//2. Check if the branch was created
$ git branch
ticket-12
* master
//3. Switch to the newly created branch
$ git checkout ticket-12
//4. Repeat Step 2
$ git branch
* ticket-12
master
//5. Commit your files and either push or pull the changes
$ git add .
$ git commit -m "Testing Push and Pull Request"
$ git push
- Send the pull review link of the new changes you added to the project. The format should look like the link bellow:
https://github.com/EXEcuted-tech/reservo-web/pull/12
If you found an issue or would like to submit and imporvement to this project, please submit an issue using the issues tab above.
This project is in its initial stages and currently there are no issues found.
Thank you for choosing the Reservo. If you have any questions or need support, please contact our Support Team. We hope you find our platform valuable for your reservation needs!
- Import the "initialize.sql" THIS IS A MUST.
- Import the ff in the EXACT ORDER:
- account.sql
- feedback.sql
- merchant_sched.sql
- merchant.sql
- inventory.sql
- package.sql
- payment.sql
- reservation.sql
- payment_alter.sql
- (e.g) To import merchant you need to import initialize, account, feedback, merchant_sched, and lastly merchant.