Quantified Planet

Setup

The application requires Node.js version 7 or later. Start with installing all dependencies by running the following command:

$ npm install

Start the server

During development use the start script which loads the variables in the .env file, before starting the server. The server watches for file changes and restarts when needed.

$ npm start

Technologies

Choo

Choo is a front-end framework for authoring websites and apps using standard JavaScript syntax and APIs. Templates are defined in JavaScript files as template literals and transformed to actual DOM nodes. The generated tree is then compared with and morphed into the real DOM tree updating where needed, much like React, just without the virtual DOM-part. Routing to and rendering views are all handled by Choo.

SUIT CSS

The CSS is written and organized following the SUIT CSS principles. The source is then processed with a few postcss plugins.

Build and deploy

When building the application, take care to update the version field in package.json. The version number is used for breaking cache and ensuring that clients are receiving up to date assets. Npm has a version command that does just this, commits it and generates a git tag.

$ npm version 2.1.0

To build and minify the application and styles run the build command. The build script will try and load the local .env file so make sure to define (overwriting) the appropriate variables before executing the script.

$ NODE_ENV=production npm run build

License

Creative Commons Attribution 3.0 Unported (CC-BY)