Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.43 KB

README.md

File metadata and controls

64 lines (42 loc) · 2.43 KB

go~mus API Documentation

Welcome to the go~mus API! You can use our API to access go~mus API endpoints, which can get information on various museums, exhibitions, products and tickets in our database.

https://giantmonkey.github.io/gomus-api-doc/

Contributing to the Documentation

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/gomus-api-doc.git
  3. cd gomus-api-doc
  4. Initialize and start Slate. You can either do this locally, or with Vagrant:
# 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. Whoa! That was fast!

Now that Slate is all set up your machine, you'll probably want to learn more about editing Slate markdown, or how to publish your docs.

Need Help? Found a bug?

Read our contribution guidelines, and then submit a issue to the Slate Github if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes.

Contributors

Slate was built by Robert Lord while at TripIt.

Thanks to the following people who have submitted major pull requests:

Also, thanks to Sauce Labs for helping sponsor the project.

Special Thanks