Giter VIP home page Giter VIP logo

booqable-api-documentation's Introduction

Booqable API Documentation

This repository contains the source for the Booqable API documentation https://developers.booqable.com/

Warning: Our API is still in Beta and we might introduce non-backwards compatible changes in the future.

Getting Started

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

  1. Clone this repository
  2. cd api-documentation
  3. Initialize and start Slate. You can either do this locally, or with Vagrant:
# either run this to run locally
asdf install
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!

Built With

Slate - API docs generator

Contributing

The API is going to be a very important part of our eco system. We've designed the docs in a way every developer is able to contribute to our API. If you find a bug or you have a great suggestion open an issue or pull request.

booqable-api-documentation's People

Contributors

lord avatar masterodin avatar chrissrogers avatar dependabot-preview[bot] avatar realityking avatar reinaris avatar cvkef avatar jhnvz avatar jkrotkalis avatar mikeralphson avatar bootstraponline avatar marcguyer avatar maks3w avatar greysteil avatar dabrorius avatar anfedorov avatar djpowers avatar dlackty avatar victorquinn avatar tjallingvanderwal avatar rezanachmad avatar kevin-buttercoin avatar jdahdah avatar coliff avatar blackxored avatar rlord avatar ritesh99rakesh avatar rickyrauch avatar mccricardo avatar readmecritic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.