Preview website
This project was created during Code for Nashville's Day of Civic Hacking to allow farmers and other food providers to notify the Society of St. Andrew of food donations available for harvest and pick up.
This is drawn from the SoSAGleanTN repo.
This project was bootstrapped with Create React App.
To start the app locally, do:
yarn install
yarn start
Note: For simple development and minor edits, you can actually use npm instead of yarn. You can even submit a pull request without installing yarn. :warning: However, if you wish to do a deployment (usually only leads on the project), you will need to delete npm's package-lock.json and start over with yarn.
Pull requests can be opened into the dev branch.
Please fork and create pull requests to respond to issues.
Please make sure you can do yarn build before you before submitting your pull request.
Only people with permissions to this firebase project (usually project leads) will be able to deploy.
To build and deploy, do:
yarn build
firebase deploy
This is only necessary for changes that affect the app (the UI). For changes to background functions, see below.
If you get warnings about firebase as a peer dependency when you do
yarn installthen you will need to manuallyyarn add firebase-adminbefore you deploy. If you get a warning about firebase functions, do annpm installin the functions directory as suggested and then re-runyarn buildbefore you try again withfirebase deploy.
Emails are sent using Sendgrid and firebase functions. To deploy/ update the function run
$ firebase deploy --only functions
The function code lives in the functions dir.
You can test the code by starting the app locally with npm or yarn (above).
Our target is for the app to be displayed on the Society of St. Andrew website. But in case something is wrong on their site, you try our firebase deployment.
- Corey Rice
- Jeannie Hunter
- Emily Lemmon
- Kevin Huber
- Shu Sajid
- Andrew Leverette