Monsterblader/EdLnkr

EdLnkr

EdLnkr is the most efficient way to build learning plans using only links from the internet.

Team

• Product Owner: Domen Vajevec
• Scrum Master: Omar Alvarez
• Development Team Members: Albert Lee, James Kolonusz

Table of Contents

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

Requirements

• Node 0.10.x
• MongoDB
• Sass (Ruby or node)
• Yeoman + angular fullstack generator

Installing Dependencies

From within the root directory:

gem install sass
npm install -g grunt grunt-cli bower yeoman 
npm install -g generator-angular-fullstack
npm install
bower install

Usage

From the root directory run:

• grunt : Runs jshint, tests and builds the project.
• grunt build : Builds the project. All production ready files are stored in the dist directory.
• grunt serve : Builds the project and runs a server locally for a preview of the site.

Development

All development is done in folders outside of root. Running grunt will build your project into the dist folder. Use the dist folder for pushing to a production server. You can find instructions for how to do so on the yeoman generator site.

An example client component in client/app

main
├── main.js                 - Routes
├── main.controller.js      - Controller for our main route
├── main.controller.spec.js - Test
├── main.html               - View
└── main.less               - Styles

An example server component in server/api

thing
├── index.js                - Routes
├── thing.controller.js     - Controller for our `thing` endpoint
├── thing.model.js          - Database model
├── thing.socket.js         - Register socket events
└── thing.spec.js           - Test

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.