Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.35 KB

README.md

File metadata and controls

49 lines (32 loc) · 1.35 KB
Raw

Adopt-A-Pothole

A crowdfunding application for New Orleans residents to sponsor the repair of potholes.

Table of Contents

Team Usage Requirements Development Installing Dependencies Contributing

Team

  • Product Owner: Jade
  • Scrum Master: Avery
  • Development Team Members: Brandon, Titus

Usage

Web application available accross platforms (desktop, tablet, and mobile). Users are able to to create crowdfunding campaigns for neighborhood potholes. They can also find potholes submitted by other users and donate to them using PayPal.

Requirements

  • Node.js

Development

Roadmap

Fork & Clone Repo from:

https://github.com/Adopt-A-Pothole/adopt-a-pothole

Installing Dependencies

From within the root directory:

  • npm install
  • npm start
  • Visit localhost:8080 in your favorite web browser

Contributing

  1. Fork the project and clone it to your local machine.
  2. Create a branch with your GitHub username as a prefix, for example: git checkout -b USERNAME/new-feature or git checkout -b USERNAME/fixing-bug where USERNAME should be replaced by your username.
  3. Code and commit your changes.
  4. Push to the branch: git push origin USERNAME/new-feature
  5. Create a pull request for your branch