FIND YOUR HOUSE API

This project started as a fork of the popular Slate API documentation tool, which uses ruby.

Welcome to the FIND YOUR HOUSE API portal. The objective of this site is to make data, including imagery, eminently accessible to application developers.

We have language bindings in Ruby, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

API AND DOCUMENTATION LINKS

• API Documentation
• API Live Demo Link

Dependencies

Minimally, you will need the following:

• Ruby >= 2.5
• Bundler
• NodeJS
• Git

Please note, only Linux and macOS are officially supported at this time. While slate should work on Windows, it is unsupported.

See below for installation instructions for different OSes / distros.

Installing Dependencies on Linux

Install Ruby, NodeJS, and tools for compiling native ruby gems:

On Ubuntu 18.04+

sudo apt install ruby ruby-dev build-essential libffi-dev zlib1g-dev liblzma-dev nodejs patch

On Fedora 31+

sudo dnf install @development-tools redhat-rpm-config ruby ruby-devel libffi-devel zlib-devel xz-devel patch nodejs

Then, update RubyGems and install bundler:

sudo gem update --system
sudo gem install bundler

Installing Dependencies on macOS

First, install homebrew, then install xcode command line tools:

xcode-select --install

Agree to the Xcode license:

sudo xcodebuild -license

Install nodejs runtime:

brew install node

Update RubyGems and install bundler:

gem update --system
gem install bundler

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/slate.git
3. cd slate
4. Install ruby gems for slate:

# either run this to run locally
bundle install

Note: if the above fails on installing nokogiri and using macOS see here for some helpful tips on things that might help.

Running slate

You can run slate in two ways, either as a server process for development, or just build html files.

To do the first option, run:

bundle exec middleman server

and you should see your docs at http://localhost:4567. Whoa! That was fast!

The second option (building html files), run:

bundle exec middleman build

Publishing Your Docs to GitHub Pages

Publishing your API documentation couldn't be more simple.

1. Make sure you're working on a fork in your own account, not our original repo: git remote show origin.
2. Commit your changes to the markdown source: git commit -a -m "Update index.md"
3. Push the markdown source changes to GitHub: git push
4. Run ./deploy.sh

What Now?

The next step is to learn how to edit source/index.md to change the content of your docs. Once you're done, you might want to think about deploying your docs.

Companies Using Slate

• NASA
• Sony
• Best Buy
• Travis-CI

You can view more in the list on the wiki.

Questions? Need Help? Found a bug?

If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to start a thread in our Discussions tab!

Found a bug with upstream Slate? Go ahead and submit an issue. And, of course, feel free to submit pull requests with bug fixes or changes to the dev branch.

Contributors

Slate was built by Robert Lord while at TripIt. The project is now maintained by Matthew Peveler and Mike Ralphson.

Thanks to X1011 for the excellent deploy script.

FIND YOUR HOUSE API was built by :

👤 Guillain Bisimwa

• Github : @guillainbisimwa
• Twitter : @gullain_bisimwa
• Linkedin : guillain-bisimwa

Show your support

Give a ⭐️ if you like this project!