Edify

Skill sharing platform

Team

• Product Owner: Colin Parsons
• Scrum Master: Timmy Luong
• Development Team Members: JP Ji, Mike Kim

Table of Contents

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

Usage

Install dependencies

Start MySQL server

Log in via Github

Requirements

• Node 0.10.x
• Express 4.12.x
• MySQL 2.7.x
• Bookshelf 0.8.x
• Knex 0.8.6
• Passport 0.2.2
• Passport-github2 0.1.9
• Bluebird 2.9.30

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
mysql.server start

From client directory

bower install

Deployment

Set up with Heroku & ClearDB (mySQL)

From root directory:

grunt build
heroku addon:add cleardb:ignite
new github application vars -> server/oauth.js
push to heroku

Database

grunt backup - Store current db as the backup
grunt reset - Restore db from backup
grunt dbInit - Initialize db with default data

Roadmap

Future

• Add upvoting system to allow user to "like" other users
• Add favorites view for user to see all "liked" entries
• Add location service to allow user to find other nearby users
• Remove dichotomy of learners/teachers and
  • replace with just learners

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.