Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.51 KB

README.md

File metadata and controls

29 lines (20 loc) · 1.51 KB
Raw

Introduction

The Kinesis Shard Calculator recommends the optimal number of shards for a Kinesis data stream, and shows the corresponding cost estimation. It also provides recommendations for improving the efficiency and lower the cost of the data stream.

See it in action here: https://comcastsamples.github.io/KinesisShardCalculator/

This repository contains the Jekyll site to display the Kinesis Shard Calculator in GitHub Pages. It leverages a GitHub Pages theme to make it pretty.

The main files are:

  • index.html : The main and only web page. It puts all the other pieces together in a single HTML page.
  • _config.yml : The Jekyll configuration file.
  • _includes/introduction.md : The introduction displayed before the actual calculator.

The calculator itself is an AngularJS application. The application logic is contained in _includes/KinesisShardsCalculator.js, and the rendering of it is made in _includes/KinesisShardsCalculator.html, which uses assets/css/styles.css for styling.

Development

In order to test it locally:

  1. Clone this git repository
  2. Install Ruby
  3. Install Jekyll:
gem install bundler jekyll
  1. Install github-pages bundle
  2. Run a local Jekyll instance with: jekyll serve
  3. Navigate with your favorite browser to: http://127.0.0.1:4000