📉 Visualisation layer and data store for SpeedTracker
Clone or download
Latest commit e76e57b Sep 16, 2017

README.md

Front-end

Backers on Open Collective Sponsors on Open Collective

v1.2.3

Visualisation layer and data store for SpeedTracker


js-standard-style

Installation

  1. Click here to request a WebPageTest API key.
  2. Fork this repository into your own GitHub account or organisation.
  3. Enable GitHub Pages for the repository under Settings > Options > GitHub Pages. Select the branch you want to serve your site from (typically master).
  4. Add speedtracker-bot as a collaborator on your repository (under Settings > Collaborators).
  5. Use the connect tool to establish a connection between SpeedTracker and your repository.
  6. Edit the main configuration file (speedtracker.yml).
  7. Edit _profiles/default.html to define your first profile.
  8. Commit and push the changed files.
  9. Use the test tool to run a test.

Development

  1. Install dependencies
npm install
  1. Start the Jekyll server
jekyll serve --watch --port SOME_PORT
  1. Start Webpack
npm run watch
  1. When you're done with your changes, build the bundle for production
npm run build

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)

License

This project is licensed under the MIT license:

The MIT License (MIT)

Copyright (c) 2016 Eduardo Bouças

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.