Skip to content

Commit 3add512

Browse files
committed
edited README
1 parent 2543d0a commit 3add512

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,32 @@
11
# 4FLOT-Website-Revamp
22

33
### Nonprofit Organization Background
4+
45
[4 Future Leaders of Tomorrow](https://4flot.com/) focuses on providing resources (ie. food, toys, housing referrals, etc.) to underprivileged communities to end homelessness, hunger, and disparity. Our proposed solution for them is to reorganize the website to have the standard pages of an organization informational website (ie. Home Page, About Us, Contact Us) with the additions of a Donations page, Testimonials page, Upcoming Events page, and Newsletter page to highlight the impact of 4FLOT in the community and ways for people to help support 4FLOT in its efforts.
56

67
## Dev Tools
7-
Tech Stack: MongoDB, Express, React, Node
8+
9+
Tech Stack: MongoDB, Express, NextJS / React, Node
810

911
Other Tools: Git, Postman
1012

1113
### Backend
14+
1215
- From slack, copy/paste the .env file into the backend directory
13-
- ```cd backend``` to change to the backend directory
14-
- ```npm install``` to install dependencies
15-
- ```npm start``` to run backend
16+
- `cd backend` to change to the backend directory
17+
- `npm install` to install dependencies
18+
- `npm start` to run backend
1619

1720
### Frontend
18-
- ```cd frontend``` to change to the frontend directory
19-
- ```npm install``` to install dependencies
20-
- ```npm run dev``` to run frontend
21+
22+
- `cd frontend` to change to the frontend directory
23+
- `npm install` to install dependencies
24+
- `npm run dev` to run frontend
2125

2226
### Linting
27+
2328
Frontend and backend directories have access to the following commands to check and fix linting issues.
24-
- ```npm run lint-check``` runs lint checks on your code.
25-
- ```npm run lint-fix``` fixes any automatically fixable lint errors.
26-
- ```npm run format``` runs code formatting checks and fixes any formatting errors.
29+
30+
- `npm run lint-check` runs lint checks on your code.
31+
- `npm run lint-fix` fixes any automatically fixable lint errors.
32+
- `npm run format` runs code formatting checks and fixes any formatting errors.

0 commit comments

Comments
 (0)