muz.li demo newsfeed repository

For demo purposes this repo stores files both for front-end and back-end.

Live demo: http://dopamineux.com/muz.li/

---

Getting Started

This project requires the fallowing environment setup:

1. Globally installed Node.js Download the installer from official Node.js site
2. Globally installed Bower Easiest way to install using npm:

npm install -g bower

3. Running rethinkDB instance. Download and run ir from https://rethinkdb.com/docs/install/
4. Preferred web server (Nginx, Apache, etc...)

Back-end

Server

Server application is build using express-js and is fully self-contained. Just run node index.js in the root folder and it will server an API

Configuration

Environmental configuration is stored in ./config folder. For demo purposes it only has default configuration for database.

Tasks

All crawlers and scrappers are implemented as standalone tasks for more versatile utility and scaling. You can run them using any task scheduler or cron tables:

• Tasks beginning with feed.* are feed crawlers. They collect most recent information from specific feeds and stores it within database
• Tasks beginning with social.* collect share data from social networks. They take command line argument for number of days, how much old posts should be updated. E.g. node social.google.js 3 - updates all 3 days old posts.

Front-end

All the required dependencies are stored in bower and npm package configs, so when you are ready, just install the project using npm:

npm install

Configuration

Global Angular application configurations is stored in js/settings.[env].js files. By default there are two environments:

• settings.local.js - used for development environment
• settings.prod.js - used for production environment

REST API

All REST API end-points are configured in Angular JS service global variables services/*.js or modules/[module_name]/services/*.js
You should configure these end-points to refer to you server API. E.g.:

var apiUrl = 'http://example.com/api/list' 

Important! All API paths should begin with api/ and content served as Content-Type:application/json.

Version control

App versions are configured at package.json file. All versions in individual environmental settings are overrided on build, from this particular file.

Building

Default grunt builds entire app and compiles all resources for development version. Where grunt pack build bakes app for production.

Note: Dont't forget to npm version patch before deploying to avoid cache related issues.

Testing

Tests are implemented on Jasmine and are ran with Karma. By default Karma is configured to run tests on Chrome browser using karma-chrome-launche but if you prefer, you can load another browser driver in karma.conf.js config file.

To run unit tests automatically whenever app changes use npm hook npm test

All tests are located in tests/ folder with extension *.spec.js. Initially there are few test examples to test controller, directive, and service - so you can use this examples to create your own tests. All tests for the separate modules should be in separate files. E.g.: [module name].controllers.spec.js

Deploying

To bake project for product environment just run grunt pack. It will uglify files and render required dependencies in the index.html file.