You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-13
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,30 @@
1
1
# StockFlux
2
2
3
-
StockFlux is an implementation of a desktop app using Openfin, written using [AngularJS](https://angularjs.org/). It pulls data from [Quandl](https://www.quandl.com/), and displays it using [BitFlux](http://scottlogic.github.io/BitFlux/). You can search for new stocks, add stocks to favourites, and tear out stocks (similar to browser tabs). You can also collapse the window into a compact view.
3
+
StockFlux is a desktop application developed by [Scott Logic](http://www.scottlogic.com/) that uses the OpenFin HTML5 container.
4
4
5
-

5
+

6
+
7
+
Here are a few things to try:
8
+
- Add and remove stocks via the search pane
9
+
- Drag tiles within the favourites pane to re-order them
10
+
- Drag a tile outside of the favourites pane to create a new application window
11
+
- Re-open recent windows via the icon at the bottom right of the favourites pane
12
+
- Use the icon on the top right of the title bar to toggle 'collapsed' mode
6
13
7
14
## Installing
8
15
9
-
You can download StockFlux from [here](http://scottlogic.github.io/StockFlux/StockFlux.zip). If you haven't already installed an OpenFin application, this will install the OpenFin runtime. It'll also add shortcuts to StockFlux to your desktop and start menu.
16
+
In order to install the application, download [StockFlux installer zipfile](http://scottlogic.github.io/StockFlux/StockFlux.zip), unzip and run the executable. If you haven't already installed an OpenFin application, this will install the required runtime. It'll also add shortcuts to StockFlux to your desktop and start menu.
10
17
11
-
Each application start up, it downloads the application from Github Pages, meaning that it will automatically update and that it cannot be used offline.
18
+
This is an 'evergreen' application, each time it launches the application code is downloaded (from GitHub pages), ensuring that it is always up-to-date.
12
19
13
-
## Developing
20
+
#Development
14
21
15
-
[npm](https://www.npmjs.com/), the package manager for [Node.js](https://nodejs.org/), is used to manage the project's dependencies. [Grunt](http://gruntjs.com/), a JavaScript task runner, is used to test and build the project.
22
+
The application is built using AngularJS and ES2016, transpiled via Babel. The charts are rendered using [d3fc](https://d3fc.io/), a Scott Logic open source project which provides a number of components that allow the creation of bespoke interactive charts. The bulk of the charting code is adapted from [BitFlux](http://scottlogic.github.io/BitFlux/), which showcases the capabilities of d3fc.
16
23
17
24
### Initial Setup
18
25
26
+
[npm](https://www.npmjs.com/), the package manager for [Node.js](https://nodejs.org/), is used to manage the project's dependencies. [Grunt](http://gruntjs.com/), a JavaScript task runner, is used to test and build the project.
27
+
19
28
- Download or clone this repository locally
20
29
- Ensure [Node.js](https://nodejs.org/), which includes npm, is installed
21
30
- Ensure [Grunt](http://gruntjs.com/getting-started#installing-the-cli) is installed:
@@ -30,15 +39,9 @@ npm install -g grunt-cli
30
39
npm install
31
40
```
32
41
33
-
- Perform an initial build:
34
-
35
-
```
36
-
grunt build
37
-
```
38
-
39
42
#### Running locally
40
43
41
-
To run in an OpenFin shell run the grunt task
44
+
To run in an OpenFin shell run the `serve`grunt task:
0 commit comments