Code Monkey home page Code Monkey logo

ipelengbela.github.io-bitflux's Introduction

A cross-platform financial charting application to showcase the functionality of d3fc components.

Visit the website to view the application.

Version Build status View
Latest release (Master) Build Status http://scottlogic.github.io/BitFlux/master/
Development Build Status http://scottlogic.github.io/BitFlux/develop/

Developing

npm, the package manager for Node.js, is used to manage the project's dependencies. Grunt, a JavaScript task runner, is used to test and build the project.

Initial Setup

  • Download or clone this repository locally
  • Ensure Node.js, which includes npm, is installed
  • Ensure Grunt is installed:
npm install -g grunt-cli
  • Navigate to the root of your local copy of this project and install the dependencies:
npm install
  • Perform an initial build:
grunt

Running

Local server

To run on local server, run the grunt task:

grunt serve

The project is then accessible at http://localhost:PORTNUMBER

GitHub Pages

For this option to be available, you should have forked the ScottLogic/BitFlux repository to your GitHub account.

To run on GitHub Pages, run the grunt command:

grunt deploy

The project is then accessible at the obvious address (USERNAME.github.io/REPO-NAME).

Development

To run a development build on a local server, run the grunt task:

grunt dev

The project is then accessible at http://localhost:PORTNUMBER

This will also start a watch task on the repository, and cause grunt to rebuild and reload the project once any file is changed.

Testing

To run the unit tests, run the grunt command:

grunt test

To generate a code coverage report, run

grunt test:coverage

License

This project is licensed under the MIT License.

ipelengbela.github.io-bitflux's People

Contributors

jleft avatar cbarrett2 avatar jdhodges avatar tlsim avatar rjmcneill avatar afredon avatar annac-c avatar drewmiley avatar rmcneillsl avatar chrisprice avatar

Watchers

James Cloos avatar Ipeleng Technologies avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.