Skip to content

nagyistge/food-bank-app

Repository files navigation

This repository is for the Food-Bank application.


Quick Start Steps:

  1. Install Node.js and MongoDB
  2. Start MongoDB
  3. git clone https://github.com/stevieoj/food-bank-app
  4. cd Food-bank-app
  5. npm install
  6. npm run dev
  7. Open http://localhost:8080 in your web browser
  8. Login with username admin@example.com password password

Detailed local development installation steps

You'll need to have the latest verison of Node.js 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 the food-bank app directory to be in. Then run git clone https://github.com/stevieoj/food-bank-app

Move to the Food-bank-app 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 username admin@example.com and password 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. Make a copy of the server/config/env/secrets-template.js file in the same directory and rename it secrets.js. After following the instructions below to obtain API Keys, put your keys in this file.

Google Maps API key required for the deliveries feature

Google API that will allow the application to work with google accounts. When you create your Client ID for Web Application, add http://localhost:8080/api/auth/google/callback to the Authorized Redirect URIs section

Sendpulse email service API. Required for the password reset by email to work.

  • Register for an account
  • Go to Settings
  • Click the API tab
  • Click Activate REST API
  • Click Save

Licence

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published