Skip to content
This repository was archived by the owner on May 27, 2020. It is now read-only.

README.md

Latest commit

 

History

History
44 lines (29 loc) · 1.65 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.65 KB

DEPRECATED - See https://github.com/blockcypher/eth-docs

BlockCypher's Ethereum Docs

This repository contains all of BlockCypher's Ethereum API documentation, presented with the help of GitHub Pages and Slate.

Running BlockCypher's Docs Locally

We welcome Pull Requests to help us improve our documentation. If you're making edits, it's a good idea to run your fork of our docs locally before submitting a Pull Request; to do so, follow these instructions straight from Slate.

Prerequisites

You're going to need:

  • Linux or OS X — Windows may work, but is unsupported.
  • Ruby, version 1.9.3 or newer
  • Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

  1. Fork this repository on Github.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/eth-docs.git
  3. cd docs
  4. Install all dependencies: bundle install
  5. Start the test server: bundle exec middleman server
# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

You can now see the docs at http://localhost:4567.

Found an error or bug?

Just submit an issue. And, of course, feel free to submit Pull Requests with bug fixes or proposed changes.

Special Thanks