https://github.com/ultraflame4/cdevrestaurantreview
Schooool Proejct
https://github.com/ultraflame4/cdevrestaurantreview
Last synced: 10 months ago
JSON representation
Schooool Proejct
- Host: GitHub
- URL: https://github.com/ultraflame4/cdevrestaurantreview
- Owner: ultraflame4
- Created: 2022-10-31T09:21:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-30T20:48:26.000Z (about 2 years ago)
- Last Synced: 2024-11-12T05:10:11.957Z (over 1 year ago)
- Language: JavaScript
- Size: 39.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RestauRant
This is a Restaurant Review website built using ReactJS and ExpressJS
This is a web development project done for school.
**Browsing / General Features**
https://github.com/ultraflame4/CDEVRestaurantReview/assets/34125174/3c876ee8-3a27-44a3-a5f6-6158688299fd
**Account Features**
https://github.com/ultraflame4/CDEVRestaurantReview/assets/34125174/64611454-7a46-4d79-924d-9df283221bab
### Searching:
This project uses the [Fuse.js](https://fusejs.io/) library to search for restaurants.
To refine your search, you can use the following search operators:
| Token | Match type | Description |
|-----------|----------------------------|--------------------------------------|
| jscript | fuzzy-match | Items that fuzzy match jscript |
| =scheme | exact-match | Items that are scheme |
| 'python | include-match | Items that include python |
| !ruby | inverse-exact-match | Items that do not include ruby |
| ^java | prefix-exact-match | Items that start with java |
| !^earlang | inverse-prefix-exact-match | Items that do not start with earlang |
| .js$ | suffix-exact-match | Items that end with .js |
| !.go$ | inverse-suffix-exact-match | Items that do not end with .go |
Taken from: https://fusejs.io/examples.html#extended-search
## Installation
1. Clone the repository
2. Run `npm install` in the root directory
## Running the project
1. `node .`
or `npm run express-run`
or
2. Run `npm run build-run` to build the client and run the server.
Alternatively, you can build the client and run server separately.
1. Run `npm run build` to build the client.
2. Run `npm run express-run` to run the server.
### Running the project in development mode
1. `npm run dev` - Runs the vite development server for the react client
2. `npm run express-dev` - Starts the express server with nodemon (auto restart for code changes).
The express server will use the files in `./dist/` folder for its static html pages
## MySQL Database Setup
This is a fullstack application that requires a MySQL database.
1. Firstly, you will need a MySQL server.
1. Get the MySQL server & MySQL Workbench using the [installer](https://dev.mysql.com/downloads/installer/)
2. Configure root username to `root` & root password to`admin`
3. Load the tables & example data from `resources/CDEVRestauRantDB20230205.sql` by either using "data import" or running the script directly.
## Things to Note:
- See icons from https://icones.js.org/
- Use library [Iconfig](https://docs.iconify.design/iconify-icon/react.html) to use icons from multiple vendors in React