siddhantprateek/restro-web
Restaurant App - It's not just food , It's an experience. š
Image
0
277
siddhantprateek/restro-web repository overview
ā Resto
Restaurant App - It's not just food , It's an experience. š
ā Tech Stack
ReactTypescriptMirage Js- Mock Server
ā Objective
- Within the menu, users have the option to filter items by searching for tag values or by conducting a regular search using item names. While the current selection of tags does not facilitate the desired data query, users can achieve a similar outcome through the search bar.
ā Setting up project for development using Docker
- To run the application locally, you have two options: either create the Docker image using
Dockerfileor utilizedocker-compose. Ensure that Docker is installed on your local machine. Or Visit Install Dockerā
docker build -t resto-web .
# or
docker-compose up -d
If prefer cloning the repository and run locally then follow bellow steps
git clone https://github.com/siddhantprateek/resto
cd resto
npm install | bun install # install dependenies(npm or bun)
npm run start # run the react application on port 3000
ā API Documentation
-
The base URL for api is
https://restaurant.service/api
| Endpoint | API Description |
|---|---|
GET /all | Fetch entire restaurant data |
GET /chef | Fetch chef details containing name, bio and signature_dist |
GET /awards | Retrieves Array of Awards(award, origanization, year) |
GET /ambinence | Retrieves about restaurant ambinence description |
GET /food/menu | Fetch all the food Items |
GET /initiatives | Retrieves all Initiative taken by restaurant |
GET /reviews | Fetch customer reviews(customer_name, comment, rating) |
GET /events | Fetch Upcoming Events(name,date, description) |
GET /website | Fetch website Url |
GET /socials | Fetch All online presence Urls (facebook, Instagram, Twitter) |
ā Website Navigation routes
- The Application is deployed on Vercel - Websiteā
URl: https://resto-steel.vercel.app/ | Description |
|---|---|
PATH / | Home Page |
PATH /about | Details about Restaurant and Chef |
PATH /menu | Shows All the Available Food Items |
PATH /events | Shows all the Upcoming Events |
PATH /initiatives | Shows All the initiatives taken by Restaurant for Sustainability |
PATH /recipes | Shows detailed Food Items |
ā Application Folder structure
- Inside Source folder
src
.
āāā App.css
āāā App.test.tsx
āāā App.tsx # application Entry point
āāā assets # assets used in components and pages
āāā components # All Components
ā āāā common # All repeated Components
ā āāā footer
ā āāā header
ā āāā hero
ā āāā index.ts # components default export
ā āāā reservations
āāā context # !Not Used, contains Global Context
āāā data
ā āāā restaurantData.json # dummy data
āāā index.css
āāā index.tsx
āāā mirage # mock server
āāā pages # contains all routing pages
ā Author
Tag summary
Content type
Image
Digest
sha256:1995a079aā¦
Size
192 MB
Last updated
over 2 years ago
docker pull siddhantprateek/restro-web