Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 755 Bytes

README.md

File metadata and controls

31 lines (20 loc) · 755 Bytes

CRM Platform API Documentation

Getting Started

Prerequisites

You're going to need:

  • Linux or macOS — 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 the project into your working directory.
  2. cd crmplatform-docs
  3. Initialize and start the project. 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.