https://github.com/freeCodeCamp/pantry-for-good
An open source food bank logistics and inventory management tool
https://github.com/freeCodeCamp/pantry-for-good
charity food food-banks inventory-management nonprofit nonprofit-organizations nonprofits opensourceforgood
Last synced: 26 days ago
JSON representation
An open source food bank logistics and inventory management tool
- Host: GitHub
- URL: https://github.com/freeCodeCamp/pantry-for-good
- Owner: freeCodeCamp
- License: other
- Archived: true
- Created: 2016-11-01T15:02:08.000Z (over 8 years ago)
- Default Branch: staging
- Last Pushed: 2019-04-29T16:18:17.000Z (almost 6 years ago)
- Last Synced: 2024-08-01T12:33:15.106Z (9 months ago)
- Topics: charity, food, food-banks, inventory-management, nonprofit, nonprofit-organizations, nonprofits, opensourceforgood
- Language: JavaScript
- Homepage:
- Size: 2.58 MB
- Stars: 389
- Watchers: 52
- Forks: 189
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - freeCodeCamp/pantry-for-good - An open source food bank logistics and inventory management tool (others)
README
[](https://travis-ci.org/freeCodeCamp/pantry-for-good)
[](https://quay.io/repository/painejs/pantry-for-good)
[](https://gitter.im/FreeCodeCamp/pantry-for-good?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
This repository is for the Pantry-for-Good application designed by Open Source for Good Contributors at [freeCodeCamp](http://www.freecodecamp.com). For deployment instructions see the [deployment guide](DEPLOYMENT.md).
If you'd like to contribute, the [contributing guide](CONTRIBUTING.md) explains the git workflow and the [developers guide](https://github.com/freeCodeCamp/pantry-for-good/wiki/developer's-guide) gives an overview of how the app works. The [open issues](https://github.com/freeCodeCamp/pantry-for-good/issues) are a good place to start, or you can try the app and add your own issues. If you get stuck or need help with something, feel free to leave a comment.
Some issues are quite large, don't feel like you have to finish them, it's ok. Little bits help too! Start slow!
There's a demo app hosted at https://pantry-for-good.herokuapp.com, though it might be a bit behind the current version.
## Installation
------------
### Local installation summary:
1. Install [Node.js](http://nodejs.org) and [MongoDB](https://docs.mongodb.com/manual/installation/#mongodb-community-edition)
2. Start MongoDB
3. `git clone https://github.com/freeCodeCamp/Pantry-for-Good.git`
4. `cd Pantry-for-Good`
5. Make sure you're on the 'staging' branch (`git branch`), otherwise run `git checkout staging`
6. `npm install`
7. `npm run dev`
8. Open in your web browser
9. Login with username `[email protected]` password `password`
------------
### Detailed local development installation steps
You'll need to have a **Node.js** version >= 6 installed. Either use your OS's package manager or follow the installation instructions on the [official website](http://nodejs.org).
This app uses **MongoDB** as its database engine. Follow [these instructions](https://docs.mongodb.com/manual/installation/#mongodb-community-edition) to install it locally and start the MongoDB server on your machine.
Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) if it is not already installed. To clone this repository to your local machine, open a command line interface and navigate to the directory where you would like to install the app. Then run
`git clone https://github.com/freeCodeCamp/Pantry-for-Good.git`
Move to the `Pantry-for-Good` directory and run the `npm install` command to install the application dependencies.
Type `npm run dev` to start the application in development mode. If all goes well, it will be available at `http://localhost:8080`. The application is pre-populated with an administrator account with `[email protected]` as username and `password` as password.
------------
### Installing API keys
To use all the features of this application you will need to obtain API keys and install them in the application. After following the instructions below to obtain API Keys, put your keys in the file `server/config/env/secrets.js`.
#### 1. [gmapsApiKey](https://developers.google.com/maps/documentation/javascript/get-api-key)
Google Maps API key for the deliveries feature. Currently, this key needs to be entered in the general settings page of your local instance of the application.
#### 2. [oauth](https://developers.google.com/identity/sign-in/web/devconsole-project)
Google+ API for allowing users to register/login with google.
#### 3. [sendgrid](https://sendgrid.com)
Sendgrid email API for sending emails.
- Register for a trial account or deploy the app and get the username/password from the heroku config vars
- Go to [Settings > API Keys](https://app.sendgrid.com/settings/api_keys) and create a key
- Paste the key in `secrets.js` or the `SENDGRID_API_KEY` config var of your deployed app.