Git Product home page Git Product logo

food-bank-app's Introduction

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 [email protected] 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 [email protected] 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

food-bank-app's People

Contributors

stevieoj avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.