CryptoChart.io, A leaderboard of top open-source cryptocurrencies
Switch branches/tags
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.
github
source
.gitignore
.ruby-version
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE
README.md
config.rb

README.md

CryptoChart

CryptoChart.io, a leaderboard of top open-source cryptocurrencies.

Contributing

Missing a cryptocurrency here? Just fork the repo and add your currency as a <name>.md in the source/projects folder.

Make sure to follow the following rules:

  • Open Source: The currency must have a public repository on Github that we can link to and pull in stats from.
  • Stick to the format: Fill out all the same fields as the other static site generators in source/projects.
  • Short description: Keep all the details for the body text, keep the description for the overview page short and sweet.

Running locally

CryptoChart is built with Middleman. To install and run locally:

git clone https://github.com/mitchellcash/cryptochart.git
cd cryptochart
bundle install (requires ruby 2.1.2 to work w/o errors)
bundle exec middleman

You'll run into GitHub's API limits very quickly if you just do this. To avoid this we recommend you create a Github API token with permissions to access public repositories and Gist.

Then create a Gist with a single file data.json with an empty javascript object literal as content: {}

Then set these environment variables before running middleman:

export GITHUB_TOKEN=YOUR_TOKEN
export GIST_ID=ID_OF_YOUR_GIST

Then middleman will use the Gist you specified to archive stats (stars, forks and issues) for the repositories.

StaticGen

CryptoChart is based off StaticGen by Netlify.

License

CryptoChart is released under the MIT License. Please make sure you understand its implications and guarantees.