Skip to content

Commit

Permalink
Merge pull request #216 from mohit-bhandari45/fix/readme
Browse files Browse the repository at this point in the history
Readme files updates
  • Loading branch information
hustlerZzZ authored Jun 5, 2024
2 parents ef0107c + d94d541 commit abac112
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 13 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,30 +62,35 @@ Welcome to Foodies, your go-to college dining companion! Designed for seamless c

## To get started with contributing to the FoodiesWeb project, follow these steps:

1. **Navigate to the Project Directory:**
1. **Fork and clone the repository**
2. **Navigate to the Project Directory:**
```bash
cd path/to/FoodiesWeb
cd FoodiesWeb
```
2. **Split Terminal for Backend Setup**
3. **Split Terminal for Backend Setup**

3. **Navigate to the Server Directory:**
4. **Navigate to the Server Directory:**
```bash
cd path/to/FoodiesWeb/server
cd server
```
4. **Install Dependencies (in both terminals):**
5. **Install Dependencies (in both terminals):**
```bash
npm install
```
5. **Start the Backend Server (in the terminal within the /server directory):** <br>

### **ENV Variables**
Setup MongoDB local host instance and port in env file in your local device. Default port is 4000
Sample uri is given below.
```
PORT=3000
DATABASE_URL="http://localhost:21713/foods"
```

6. **Start the Backend Server (in the terminal within the /server directory):** <br>
In the terminal where you navigated to the /server directory, run the following command to start the backend server:
```bash
nodemon server.js
```
6. **Navigate to the src (with Backend Running):**<br>
In the other terminal, run the following command to navigate to the src folder (frontend):
```bash
cd src
```
7. **Start the React App (with Backend Running):**<br>
After navigating run the following command to start the React app with the backend server running successfully:
```bash
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"@testing-library/user-event": "^13.5.0",
"aos": "^2.3.4",
"axios": "^1.5.1",
"dotenv": "^16.4.5",
"framer-motion": "^11.1.9",
"react": "^18.2.0",
"react-dom": "^18.2.0",
Expand Down
2 changes: 1 addition & 1 deletion server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"cookie-parser": "^1.4.6",
"cors": "^2.8.5",
"datauri": "^4.1.0",
"dotenv": "^16.3.1",
"dotenv": "^16.4.5",
"express": "^4.18.2",
"express-async-handler": "^1.2.0",
"faker": "^5.5.3",
Expand Down
1 change: 1 addition & 0 deletions src/pages/Signup.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ function Signup() {
navigate("/home");
})
.catch((error) => {
console.log(error)
toast.error("Failed To create account");
});
} else {
Expand Down

0 comments on commit abac112

Please sign in to comment.