https://github.com/devinwalker/give-io-documentation
https://github.com/devinwalker/give-io-documentation
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devinwalker/give-io-documentation
- Owner: DevinWalker
- License: other
- Created: 2018-01-22T03:42:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-13T02:48:23.000Z (over 8 years ago)
- Last Synced: 2025-07-24T14:04:06.457Z (10 months ago)
- Language: JavaScript
- Homepage: https://devinwalker.github.io/give-io-documentation/
- Size: 269 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Give.io API Documentation #
Repository of documentation for the Give.io REST API.
This project is based on [Slate](https://github.com/tripit/slate).
## Adding to the Documentation
### 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.
### Getting Set Up
```shell
# clone repo
git clone https://github.com/DevinWalker/give-io-documentation documentation
cd documentation
# 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](http://localhost:4567).