nmvw / genesis

Video-based auctioning

Project Genesis

MEAN stack, WebRTC-based video-auction webapp

Team

• Product Owner: Artem Svjatickis
• Scrum Master: Nick Vinson
• Development Team Members: Jonathan Huang, Mher Khanoyan

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Roadmap
6. Contributing

Usage

WebRTC is a powerful, TCP-based, peer-2-peer communication technology. Here, we rely on the PubNub API to do the heavy lifting video broadcasting as we focus our scope on building out the client-side of the auction web app. Passport was integrated to satisfy client authentication standards.

Requirements

• Node 4.4.2
• Mongoose ^4.4.11
• Passport ^0.3.2
• MongoDB
• Socket.IO ^1.4.5
  • Broadcasting bid updates in real-time
• PubNub
  • Developer publish and subscribe API keys:

  var publish_key = process.env.PUBNUB_PUBLISH_KEY;
  var subscribe_key = process.env.PUBNUB_SUBSCRIBE_KEY;

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Tasks

From within the root directory:

1. Create a bare .env file
2. Include your publish/subscribe keys as key=value pairs

Finally,

heroku local

Team

• Artem "Authentication" Svjatickis

  • A lean, mean, authentication-hungry machine, Artem enjoys long walks on the beach discussing ways to hack hollow security systems over vodka.

• Mher "Monster" Khanoyan

  • A champion of all-nighters, Mike takes working hard to the extreme with all-time favorites Monster and Red Bull. You'll never catch him taking a nap.

• Jonathan "JavaScript" Huang

  • Angular directives? Bootstrap? Vodka? He'll have ECMAScript5 with a healthy pitch of vanilla, shaken, not stirred.

• Nicolas "Nix" Vinson

  • Looking to play musical chairs integrating strange APIs? Nick is your guy.

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.