/github.highcharts.com

Node.js server which runs a RESTful application to serve Highcharts scripts built from the Highcharts build script.
  1. JavaScript 98.6%
  2. CSS 1.1%
  3. HTML 0.3%
JavaScript CSS HTML
Find file
Latest commit a03bef3 Nov 23, 2016 @jon-a-nygaard jon-a-nygaard Addition to update of download builder.
Permalink
Failed to load latest commit information.
app Addition to update of download builder. Nov 23, 2016
assembler Updated the Highcharts Assembler. Oct 27, 2016
assets Added favicon to the project. Sep 9, 2016
source/download Updated download builder to Highcharts v5.0.4 Nov 23, 2016
views Created simple application with frontpage and hello world responses. Sep 1, 2016
.eslintrc Modified eslint configuration to allow es6. Sep 7, 2016
.gitignore Added getDownloadFiles to dynamically know which files to download. Oct 12, 2016
README.md Renamed the folder helper to app. Oct 13, 2016
changelog.md Updated download builder to Highcharts v5.0.4 Nov 23, 2016
package.json Updated download builder to Highcharts v5.0.4 Nov 23, 2016
server.js Fixed issue with custom body parser. Oct 27, 2016

README.md

github.highcharts.com

Node.js server which runs a RESTful application to serve Highcharts scripts built from the Highcharts build script.

Code documentation

Each file contains a descriptive header, mentioning its author, purpose and so on. Every function contains a JSDoc header.

Install

Clone repository and put the repository folder in the same folder which the Highcharts repository folder is located.

Open a CLI and run the command: npm install

Run the application

Open a CLI and run the command: npm run start

Open http://localhost:80 in a browser and you should see the index page of the app. You can edit which port the application listens to, by setting the attribute port in config.json.

To stop the application from running, open a CLI and run npm run stop.

Update the Highcharts version used in the Download Builder

Open a CLI and run the following command:

npm run update-download-source

Commit the changes to Github.

Do deployment of new version.

@todo Publish the part files as ES6 modules on NPM and then require them. This way it will always be up to date.

Update the Highcharts assembler

Open a CLI and run the following command:

npm run update-assembler

Commit the changes to Github.

Do deployment of new version.

@todo Publish the assembler on NPM and then require it. This way it will always be up to date.

File Structure

Folders

- app
- assembler
- assets
- logs
- node_modules
- source
- tmp
- views

app

Contains all the application JS code.

assembler

All the files of the Highcharts assembler, copied directly from the Highcharts repository.

assets

Contains assets like CSS, images, etc.

logs

Temporary folder where error logs are written to.

Important: Shall not be committed to Github, nor deployed.

@todo Write log files to tmp folder, in stead of logs.

node_modules

Where the Node modules are installed.

Important: Shall not be committed to Github, nor deployed.

source

Where the source files of the Download Builder is located.

tmp

Where the temporary files used in the application is written. The temporary files are deleted by the application after use.

Important: Shall not be committed to Github, nor deployed.

views

Where the HTML files are located.

Deployment