zsherman / stockplum Goto Github PK

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

• Ruby version

• System dependencies

• Configuration

Compiling bourbon requires sass 3.3 which sass-rails does not support, therefore in order to run lineman you might need to uncomment out sass-rails temporarily and add ‘gem sass’ to the gemfile.

Almost everything should get compiled in lineman with a bower install, however using neat with bourbon requires some changes to the core scss files, make sure to replicate those (find instruction on github/neat) before running the app.

• Database creation

• Database initialization

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

• Libraries in Use

angular-ui.github.io github.com/HubSpot/pace github.com/rileyjshaw/sweep www.amcharts.com/ www.tnoda.com/blog/2013-12-19 www.highcharts.com/stock/demo/basic-line/dark-unica

• Potential Data Sources

www.kibot.com/historical_data/All_Stocks_Historical_Intraday_Data.aspx www.quandl.com/help/api-for-stock-data www.xignite.com/product/BATS-real-time-stock-quotes-data/ markitondemand.com stocklytics.com

Please feel free to use a different markup language if you do not plan to run rake doc:app.