Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhishekrawe/restaurant-listing
Restaurant Listing Platform
https://github.com/abhishekrawe/restaurant-listing
crud design javascript material-ui mysql nodejs react
Last synced: 1 day ago
JSON representation
Restaurant Listing Platform
- Host: GitHub
- URL: https://github.com/abhishekrawe/restaurant-listing
- Owner: abhishekrawe
- Created: 2023-11-05T06:13:13.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-06T04:59:46.000Z (over 1 year ago)
- Last Synced: 2023-11-07T05:42:07.003Z (over 1 year ago)
- Topics: crud, design, javascript, material-ui, mysql, nodejs, react
- Language: JavaScript
- Homepage:
- Size: 558 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Restaurant Listing Platform
Welcome to the Restaurant Listing platform.
## Features
- **Search:** Easily search for restaurants by restaurant name.
- **Add:** Add the new Restaurant list with Name, contact, address, and Image link.
- **Update:** Update the new Restaurant list with Name, contact, address, and Image link.
- **Delete:** Delete the Specific restaurant item from the list.
## Technologies Used
- **Frontend:** JavaScript, React.js, Material UI
- **Backend:** MySQL, Node.js, Express.js
## 🃏Glimse of Project ⏬
### `video `
https://github.com/abhishekrawe/restaurant-listing/assets/65603830/1eb008bb-ddf6-4f5f-b9da-c3a14177a88f
## MySQL Database Schema
### Table: restaurant
| Column | Type | Details |
|----------|---------------|----------------------|
| id | int | Primary Key, Auto-increment |
| name | varchar(45) | Restaurant name |
| address | varchar(255) | Address of the restaurant |
| contact | varchar(45) | Contact information |
| picture | varchar(350) | Picture URL/link |
### Description
The 'restaurant' table in the MySQL database contains crucial information about restaurants. Here's a breakdown of the columns:
- **id:** Unique identifier for each restaurant entry. It's set as the primary key and auto-increments to ensure each restaurant has a distinct identifier.
- **name:** A field to store the name of the restaurant.
- **address:** Contains the address information of the restaurant.
- **contact:** Stores contact details such as a phone number or email address.
- **picture:** A field to store a URL or a link pointing to a picture associated with the restaurant.
This schema design allows for efficient storage and retrieval of essential details related to various restaurants.
## Installation
To run the backend locally:
1. Clone this repository.
2. Navigate to the project directory.
3. Cd to Backend
4. Install dependencies using `npm install`.
6. Run `node index.js` to start the server.
7. Access the platform via your browser at `http://localhost:5500`.
To run the frontend locally:
1. Navigate to the project directory.
2. Cd to Frontend
3. Install dependencies using `npm install`.
4. Run `npm start` to start the client.
5. Access the platform via your browser at `http://localhost:3000`.
## Usage
1. Explore restaurants by searching.
3. Add Delete and Update the Item with name address contact and image link.
## Contributing
We welcome and encourage contributions. To contribute to the project:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make changes and commit them.
4. Push your changes to your branch.
5. Submit a pull request.
## License
This project is licensed under the [MIT License](LICENSE).
## Acknowledgements
We want to extend our gratitude to the developers and contributors who have helped make this project possible.