Skip to content

Commit

Permalink
Merge pull request #79 from Eathub-Enterprise/master
Browse files Browse the repository at this point in the history
Update#101
  • Loading branch information
Night-Prime authored Jan 4, 2024
2 parents 00300df + 56e67aa commit 8ce636a
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 15 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
# Eathub - Web
A SaaS Platform for Ordering Meals and Onboarding Food Vendors
Legacy version used for React- version 18
Saas CRM Platform for Food Businesses to track important metrics and the tools they need to generate more sales and reach new customers.

## Installation
## Guide to Firing up this Project
1. Navigate to web-app file : './web-app'
2. npm i into the terminal to install dependencies
3. npm start to run in dev mode

## Git-Collboration
## Seamless Git Collaboration
To switch branch : git checkout <branch-name>
To Push Contents to GitHub branch, after changes has been commited : git push
Merge Contents from another branch : git pull origin <branch-name>
# Never work on a branch that isnt yours
# Master branch should be protected at all cost.

Material UI Docs: https://mui.com/material-ui/getting-started/installation/
# ⚠️ Never work on a branch that isnt yours
# ⚠️ Master branch should be protected at all cost.

React-RouterV6 Docs: https://reactrouter.com/en/v6.3.0/getting-started/installation

## Rules
1. Verfiy you are on your branch before writing to this Codebase
2. Always pull from the Review Branch to your code environment before coding.
2. Always pull from the Review Branch to your code environment before making any changes or implementing feature.
3. After every feature, bug fixes or code maintenance is done, push your code changes to your personal branch.
4. Always create a pull request for code review and merging your changes.
4. Always create a pull request for code review and wait request for merging your changes.
5. Ensure Your Pull-Request has been reviewed before commiting other changes.

## ReduxJS/Toolkit used for State Management
## React-Redux used for State Management
- We'd be use RTK as an upgrade in the future.

# Styling:
- VanillaCss should be used only.

# Branches[Information]:
Overhaul - An Isolated branch, Only Admin has access to this branch, it holds the static website template and it's majorly dedicated to storing that.
Experiment - This should only be used for when we are working integrating a major feature/ service that could break the entire-app, consider this branch as a sort of sandbox for that.
1 change: 1 addition & 0 deletions web-app/src/Assets/lotties/zBpI3Bgej3.json

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions web-app/src/api/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// Production Endpoint
// export const URL = "https://eathub.live/api/v1";

// Remember to switch URL below to testURL back and uncomment the Production endpoint above
export const URL = "https://eathub.live/api/v1";

// Test Server Endpoint
export const URL = "http://emachine.pythonanywhere.com/api/v1";
export const testURL = "http://emachine.pythonanywhere.com/api/v1";

// Local Endpoint -- only use during testing for Daniel's machine
// export const testURL = "http://127.0.0.1:8080/api/v1"

0 comments on commit 8ce636a

Please sign in to comment.