Documentation Frontend

Frontend

These docs are for the frontend folder i.e. the React Project.
If you are looking for some other docs, then please refer here.

The frontend folder is a Create React App Project

The project structure for the React App (frontend) is shown below:

src
├── assets                            
|  └─ ...        
|       
├── components                                         
│  ├─ AddressBar.js                      
│  ├─ CartBar.js    
│  ├─ CartItems.js    
│  ├─ FoodItem.js    
│  ├─ Header.js                         
│  ├─ LoginForm.js                      
│  ├─ OrdersPage.js     
│  ├─ PaymentsBar.js   
│  ├─ RegisterForm.js   
│  ├─ RestaurantBanner.js  
│  ├─ RestaurantList.js   
|  └─ ...  
|  
├── context                                     # Contains user authentication code
│  └─ AuthContext.js                           
|   
├── pages                      
│  ├─ CheckoutCancelPage.js     
│  ├─ CheckoutPage.js  
│  ├─ CheckoutSuccessPage.js                      
│  ├─ HomePage.js                      
│  ├─ LandingPage.js    
│  ├─ LoginPage.js    
│  ├─ RegisterPage.js     
│  ├─ UserProfile.js  
│  ├─ ViewFoodItems.js   
|  └─ ...  
|  
├── utils                     
│  └─ PrivateRoute.js                           
|   
├── restaurants                                  # A sub-app for 'restaurants'
│  ├─ assets  
│  ├─ components  
│  ├─ context   
│  ├─ pages    
│  ├─ utils     
│  └─ ...     
|  
├── App.js                       
├── App.css  
└── index.js              

---

Overall Working

The main working of React JS is to get data from backend by making API calls to an endpoint and then displaying the retrieved data to the end user. Vice versa, it's job is also to submit data to backend by making POST API calls to an endpoint in the backend.

There is a separate folder called restaurants which is kind of a sub-app for the restaurants (similar to how there's a different app for restaurants in the backend). The sub-app is for restaurant owners, where they can login, list/manage their food items, and perform all the restaurant owner features which we provide to them.

NOTE: This documentation is open to contributions. Feel free to create a new issue if you'd like to add anything to the docs.