API documentation
Clone or download
Pull request Compare This branch is 5 commits ahead, 75 commits behind lord:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
lib
source
.gitignore
.travis.yml
CHANGELOG.md
Gemfile
Gemfile.lock
LICENSE
README.md
Vagrantfile
config.rb
deploy.sh
font-selection.json

README.md

This is the documentation for the CharityBase API - the main content is in source/index.html.md. It was generated using Slate.

For the API itself, see https://github.com/charity-base/charity-base-api

Any corrections by pull request are appreciated :)

Prerequisites

You're going to need:

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

Useful commands

# Install dependencies
bundle install
# Run locally for development
bundle exec middleman server
# Build for production
bundle exec middleman build --clean