Skip to content

Commit c37aee5

Browse files
committed
updates readme
1 parent dd3eef3 commit c37aee5

File tree

1 file changed

+23
-30
lines changed

1 file changed

+23
-30
lines changed

README.md

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,46 @@
11
# Project Title
2-
3-
Simple overview of use/purpose.
2+
🧑‍🌾 Mississippi Farm to School Network
43

54
## Description
65

7-
An in-depth paragraph about your project and overview of use.
6+
This is a fullstack (svelte + express + postgres) application for the Mississippi Farm to School Network (MFSN). MFSN is a statewide nonprofit helping schools access fresh produce from local farms. In more detail, their focus is helping schools and farmers navigate procurement processes and strengthening local food systems across Mississippi.
7+
8+
MFSN currently faces difficulties in efficiently connecting farmers with schools, accessing up-to-date farm information, and providing visibility (particularly for minority farmers and small producers).
9+
10+
The current process is manual, time-intensive, and involves significant back-and-forth communication between all parties.
811

912
## Getting Started
1013

11-
### Dependencies
14+
git clone git@github.com:uwblueprint/mississippi-farm-to-school-network.git
1215

13-
* Describe any prerequisites, libraries, OS version, etc., needed before installing program.
14-
* ex. Windows 10
16+
`cd mississippi-farm-to-school-network`
17+
Create .env files in both backend and frontend folders (empty for now)
1518

16-
### Installing
19+
`cd backend`
20+
`npm install`
1721

18-
* How/where to download your program
19-
* Any modifications needed to be made to files/folders
22+
`cd ../frontend`
23+
`npm install`
2024

21-
### Executing program
25+
Ensure Docker Daemon is running.
2226

23-
* How to run the program
24-
* Step-by-step bullets
25-
```
26-
code blocks for commands
27-
```
27+
`cd ..`
28+
`docker-compose build`
29+
`docker-compose up`
2830

29-
## Help
3031

31-
Any advise for common problems or issues.
32-
```
33-
command to run if program contains helper info
34-
```
32+
### Dependencies
3533

36-
## Authors
34+
[Git](https://git-scm.com/)
35+
[Node.js](https://nodejs.org/)
36+
Preferred code editor (either VSCode or cursor is fine)
37+
[Docker.com](https://www.docker.com/products/docker-desktop)
3738

38-
Contributors names and contact info
39+
## Authors
3940

4041
Tony Qiu
4142
[@tony_q04](https://www.instagram.com/tony_q04/)
4243

43-
## Version History
44-
45-
* 0.2
46-
* Various bug fixes and optimizations
47-
* See [commit change]() or See [release history]()
48-
* 0.1
49-
* Initial Release
50-
5144
## License
5245

5346
This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details

0 commit comments

Comments
 (0)