analisanazari / greencast

Browser based podcast app - Hack Reactor Greenfield project

GreenCast

GreenCast is a PodCast listening App which allows users to search the iTunes API for PodCasts, subscribe to and unsubscribe from Channels, and receive a feed containing a subscribed Channel's most recent Episodes. An audio player at the bottom of the screen allows the User to adjust volume, play, pause, and move to different locations in the PodCast.

Table of Contents

1. Team
2. Usage
3. Requirements
4. Development A. Installing Dependencies B. Roadmap C. API
5. Contributing

Team

• Product Owner: Will Simmons
• Scrum Master: Chase Starr
• Development Team Members: Meredith Nachman, Hans Trautlein

Usage

npm run start -dev

Requirements

• Node 6.7
• Express 4.14.x
• MongoDB 3.x
• React 0.14.7

Development

Installing Dependencies

From within the root directory:

npm install

Roadmap

View the project roadmap here

API

Method	Uri	Authorization	Comment
GET	/	Anonymous	GreenCast HomePage & Login
GET	/user/:username/subscriptions	User	User's Podcast Subscriptions
POST	/user/:username/subscriptions	User	Add a Podcast to a User's Subscriptions
DELETE	/user/:username/subscriptions	User	Remove a Podcast from a User's Subscriptions
GET	/channel/:channelId	User	View A PodCast Channel's Episodes
GET	/api/toppodcasts	Anonymous	Displays top PodCasts on HomePage
GET	/logout	User	Logs a User out of App
GET	/auth/github	Anonymous	User directed to Github for authentication
GET	/auth/github/callback	User	Redirect to HomePage or User's HomePage

Contributing

See CONTRIBUTING.md for contribution guidelines.