The client for the sirko engine making predictions about users' navigation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
test
.gitignore
.travis.yml
LICENSE.txt
README.md
karma.conf.js
package-lock.json
package.json
rollup.config.js
rollup.sw.config.js

README.md

Sirko Client

Build Status

It is a JavaScript client for the Sirko Engine. This client tracks information about navigation of users on a site and gets prediction from the engine in order to improve performance of the site by prefetching resources which are required for a next page.

Try demo

Development

Major dependencies

  • Rollup creates a bundle which should be included into the site.
  • Rollup Bubel compiles ES2015 with Rollup.
  • Karma runner launches tests in different browsers to prove that the client works fine.
  • Mocha framework is a JavaScript test framework.
  • Chai is an assertion lib for tests.

Setup

Install dependencies:

$ npm install

Start

$ npm start

This command launches Rollup in the development mode (all scripts get recompiled once changes are saved).

Testing

$ npm test

It will launch the Chrome and Firefox browsers and keep them running to re-launch tests when the code gets changed.

Production build

$ npm run-script build

It builds the dist/sirko.js script which should be included into the site.

License

The library is distributed under the GPLv3 license.