Project Name

CityMeal

Project Description

To help New Yorkers who can't afford food, CityMeal offers information for free meal sites. Users can check the location on a list and Google map. Users can also rate free meal sites they visited and check ratings from other people.

Team

• Product Manager: Seola Carrano
• Scrum Master: Phoenix McKnight
• Development Team Members: Rosmary Fermin, Yemisi Onayemi

Table of Contents

• Project Name
• Project Description
  • Team
  • Table of Contents
  • Usage
  • Requirements
  • Development
    • Installing Dependencies
    • Roadmap
  • Contributing
  • Style Guide

Usage

Some usage instructions for getting the app up and running locally

Requirements

• Node 0.10.x
• Redis 2.6.x
• Postgresql 9.1.x
• etc
• etc

Development

Installing Dependencies

From within the root directory:

npm install

once dependencies have been installed, create a .env file

NODE_ENV=development
HOST = "localhost"
PORT = 3000
PGUSERNAME = "{USERNAME}"
PGPASSWORD = "{PASSWORD}"
DBPORT = {DB PORT}
DB_NAME = {DB NAME}
secret = citymealsquad

Roadmap

View the project roadmap here.

Contributing

See CONTRIBUTING.md for contribution guidelines.

Style Guide

This project adheres to the StandardJS Style Guide.