search

freeCodeCamp / pantry-for-good

An open source food bank logistics and inventory management tool
Other
395 stars 189 forks source link
charity food food-banks inventory-management nonprofit nonprofit-organizations nonprofits opensourceforgood

readme

Build Status Docker Repository on Quay Join the chat at https://gitter.im/FreeCodeCamp/pantry-for-good

This repository is for the Pantry-for-Good application designed by Open Source for Good Contributors at freeCodeCamp. For deployment instructions see the deployment guide.

If you'd like to contribute, the contributing guide explains the git workflow and the developers guide gives an overview of how the app works. The open 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 and MongoDB
  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 http://localhost:8080 in your web browser
  9. Login with username admin@example.com 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.

This app uses MongoDB as its database engine. Follow these instructions to install it locally and start the MongoDB server on your machine.

Install 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 admin@example.com 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

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

Google+ API for allowing users to register/login with google.

3. sendgrid

Sendgrid email API for sending emails.