Skip to content

Commit

Permalink
edited README
Browse files Browse the repository at this point in the history
  • Loading branch information
jennymar committed Jan 21, 2024
1 parent 2543d0a commit 3add512
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
# 4FLOT-Website-Revamp

### Nonprofit Organization Background

[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.

## Dev Tools
Tech Stack: MongoDB, Express, React, Node

Tech Stack: MongoDB, Express, NextJS / React, Node

Other Tools: Git, Postman

### Backend

- From slack, copy/paste the .env file into the backend directory
- ```cd backend``` to change to the backend directory
- ```npm install``` to install dependencies
- ```npm start``` to run backend
- `cd backend` to change to the backend directory
- `npm install` to install dependencies
- `npm start` to run backend

### Frontend
- ```cd frontend``` to change to the frontend directory
- ```npm install``` to install dependencies
- ```npm run dev``` to run frontend

- `cd frontend` to change to the frontend directory
- `npm install` to install dependencies
- `npm run dev` to run frontend

### Linting

Frontend and backend directories have access to the following commands to check and fix linting issues.
- ```npm run lint-check``` runs lint checks on your code.
- ```npm run lint-fix``` fixes any automatically fixable lint errors.
- ```npm run format``` runs code formatting checks and fixes any formatting errors.

- `npm run lint-check` runs lint checks on your code.
- `npm run lint-fix` fixes any automatically fixable lint errors.
- `npm run format` runs code formatting checks and fixes any formatting errors.

0 comments on commit 3add512

Please sign in to comment.