|
1 | 1 | # Project Title |
2 | | - |
3 | | -Simple overview of use/purpose. |
| 2 | +🧑🌾 Mississippi Farm to School Network |
4 | 3 |
|
5 | 4 | ## Description |
6 | 5 |
|
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. |
8 | 11 |
|
9 | 12 | ## Getting Started |
10 | 13 |
|
11 | | -### Dependencies |
| 14 | +git clone git@github.com:uwblueprint/mississippi-farm-to-school-network.git |
12 | 15 |
|
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) |
15 | 18 |
|
16 | | -### Installing |
| 19 | +`cd backend` |
| 20 | +`npm install` |
17 | 21 |
|
18 | | -* How/where to download your program |
19 | | -* Any modifications needed to be made to files/folders |
| 22 | +`cd ../frontend` |
| 23 | +`npm install` |
20 | 24 |
|
21 | | -### Executing program |
| 25 | +Ensure Docker Daemon is running. |
22 | 26 |
|
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` |
28 | 30 |
|
29 | | -## Help |
30 | 31 |
|
31 | | -Any advise for common problems or issues. |
32 | | -``` |
33 | | -command to run if program contains helper info |
34 | | -``` |
| 32 | +### Dependencies |
35 | 33 |
|
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) |
37 | 38 |
|
38 | | -Contributors names and contact info |
| 39 | +## Authors |
39 | 40 |
|
40 | 41 | Tony Qiu |
41 | 42 | [@tony_q04](https://www.instagram.com/tony_q04/) |
42 | 43 |
|
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 | | - |
51 | 44 | ## License |
52 | 45 |
|
53 | 46 | This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details |
|
0 commit comments