Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.5 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.5 KB

feedpile

Build Status Coverage Status

About App:
Too much time is spent scouring the web for headlines and jumping between scores of open tabs; Feedpile gives you access to the top stories in a single page app.

Team

  • Product Owner: Darin Allen
  • Scrum Master: Alex Rosenthal
  • Senior Software Engineers: Mohammad Farooqi, Faiz Mohammad

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Roadmap
  4. Contributing

Usage

  1. Fork and clone repo.
  2. Install dependencies.
  3. Run npm run deploy to start the server.
  4. Navigate to localhost:8081.

Requirements

  • Node 4.1.1
  • Node Package Manager 3.10.10
  • MongoDB 3.4.3 (if you're interested in having the application run locally)
  • Webpack 2.3.3

Development

Installing Dependencies

From the root directory,


$ npm install
$ npm install webpack -g
$ touch .env
$ echo "MONGODB_URI=''" >> .env

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.