{"id":14955419,"url":"https://github.com/guillainbisimwa/find-house-api-doc","last_synced_at":"2026-01-21T02:02:22.903Z","repository":{"id":104692240,"uuid":"363922182","full_name":"guillainbisimwa/Find-house-api-doc","owner":"guillainbisimwa","description":"Welcome to the FIND YOUR HOUSE API portal. The objective of this site is to make data, including imagery, eminently accessible to application developers.","archived":false,"fork":false,"pushed_at":"2021-05-12T19:48:08.000Z","size":437,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T09:43:38.109Z","etag":null,"topics":["api","bundler","documentation","house-api","rails6","ruby"],"latest_commit_sha":null,"homepage":"http://gbisimwa.me/Find-house-api-doc/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guillainbisimwa.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-03T12:28:08.000Z","updated_at":"2021-05-26T11:06:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"faa9a5c2-7ed6-4885-9f91-6c655dffb9da","html_url":"https://github.com/guillainbisimwa/Find-house-api-doc","commit_stats":{"total_commits":21,"total_committers":1,"mean_commits":21.0,"dds":0.0,"last_synced_commit":"385cd1267e5d7f91c30e4f42b1b1b80152c2f7ef"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":"slatedocs/slate","purl":"pkg:github/guillainbisimwa/Find-house-api-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillainbisimwa%2FFind-house-api-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillainbisimwa%2FFind-house-api-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillainbisimwa%2FFind-house-api-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillainbisimwa%2FFind-house-api-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guillainbisimwa","download_url":"https://codeload.github.com/guillainbisimwa/Find-house-api-doc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillainbisimwa%2FFind-house-api-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28622472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T23:49:58.628Z","status":"online","status_checked_at":"2026-01-21T02:00:08.227Z","response_time":86,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bundler","documentation","house-api","rails6","ruby"],"created_at":"2024-09-24T13:11:07.786Z","updated_at":"2026-01-21T02:02:22.888Z","avatar_url":"https://github.com/guillainbisimwa.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FIND YOUR HOUSE API\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./source/images/logo.png\" alt=\"API Documentation\" width=\"226\"\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n\u003e This project started as a fork of the popular [Slate](https://github.com/tripit/slate) API documentation tool, which uses ruby.\n\nWelcome to the FIND YOUR HOUSE API portal. The objective of this site is to make data, including imagery, eminently accessible to application developers.\n\nWe 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.\n\n\u003cimg src=\"./source/images/Screenshot.png\" alt=\"Screenshot\" style=\"margin: auto; display: block\"\u003e\n\n## API AND DOCUMENTATION LINKS\n\n- [API Documentation](http://gbisimwa.me/Find-house-api-doc/)\n- [API Live Demo Link](https://find-your-house-backend.herokuapp.com/)\n\n## Dependencies\n\nMinimally, you will need the following:\n\n- [Ruby](https://www.ruby-lang.org/en/) \u003e= 2.5\n- [Bundler](https://bundler.io/)\n- [NodeJS](https://nodejs.org/en/)\n- [Git](https://git-scm.com/)\n\nPlease note, only Linux and macOS are officially supported at this time. While slate should work on Windows, it is unsupported.\n\nSee below for installation instructions for different OSes / distros.\n\n### Installing Dependencies on Linux\n\nInstall Ruby, NodeJS, and tools for compiling native ruby gems:\n\n**On Ubuntu 18.04+**\n\n```bash\nsudo apt install ruby ruby-dev build-essential libffi-dev zlib1g-dev liblzma-dev nodejs patch\n```\n\n**On Fedora 31+**\n\n```bash\nsudo dnf install @development-tools redhat-rpm-config ruby ruby-devel libffi-devel zlib-devel xz-devel patch nodejs\n```\n\nThen, update RubyGems and install bundler:\n\n```bash\nsudo gem update --system\nsudo gem install bundler\n```\n\n### Installing Dependencies on macOS\n\nFirst, install [homebrew](https://brew.sh/), then install xcode command line tools:\n\n```bash\nxcode-select --install\n```\n\nAgree to the Xcode license:\n\n```bash\nsudo xcodebuild -license\n```\n\nInstall nodejs runtime:\n\n```bash\nbrew install node\n```\n\nUpdate RubyGems and install bundler:\n\n```bash\ngem update --system\ngem install bundler\n```\n\n## Getting Set Up\n\n1. Fork this repository on Github.\n2. Clone _your forked repository_ (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git`\n3. `cd slate`\n4. Install ruby gems for slate:\n\n```shell\n# either run this to run locally\nbundle install\n```\n\nNote: if the above fails on installing nokogiri and using macOS see\n[here](https://github.com/sparklemotion/nokogiri.org/blob/master/docs/tutorials/installing_nokogiri.md#macos)\nfor some helpful tips on things that might help.\n\n## Running slate\n\nYou can run slate in two ways, either as a server process for development, or just build html files.\n\nTo do the first option, run:\n\n```bash\nbundle exec middleman server\n```\n\nand you should see your docs at http://localhost:4567. Whoa! That was fast!\n\nThe second option (building html files), run:\n\n```bash\nbundle exec middleman build\n```\n\n## Publishing Your Docs to GitHub Pages\n\nPublishing your API documentation couldn't be more simple.\n\n1. Make sure you're working on a fork in your own account, not our original repo: `git remote show origin`.\n2. Commit your changes to the markdown source: `git commit -a -m \"Update index.md\"`\n3. Push the markdown source changes to GitHub: `git push`\n4. Run `./deploy.sh`\n\n## What Now?\n\nThe next step is to [learn how to edit `source/index.md` to change the content of your docs](Markdown-Syntax). Once you're done, you might want to think about [deploying your docs](https://github.com/slatedocs/slate/wiki/Deploying-Slate).\n\n## Companies Using Slate\n\n- [NASA](https://api.nasa.gov)\n- [Sony](http://developers.cimediacloud.com)\n- [Best Buy](https://bestbuyapis.github.io/api-documentation/)\n- [Travis-CI](https://docs.travis-ci.com/api/)\n\nYou can view more in [the list on the wiki](https://github.com/slatedocs/slate/wiki/Slate-in-the-Wild).\n\n## Questions? Need Help? Found a bug?\n\nIf 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](https://github.com/slatedocs/slate/discussions)!\n\nFound a bug with upstream Slate? Go ahead and [submit an issue](https://github.com/slatedocs/slate/issues). And, of course, feel free to submit pull requests with bug fixes or changes to the `dev` branch.\n\n## Contributors\n\nSlate was built by [Robert Lord](https://lord.io) while at [TripIt](https://www.tripit.com/). The project is now maintained by [Matthew Peveler](https://github.com/MasterOdin) and [Mike Ralphson](https://github.com/MikeRalphson).\n\nThanks to [X1011](https://github.com/X1011/git-directory-deploy) for the excellent deploy script.\n\nFIND YOUR HOUSE API was built by :\n\n👤 **Guillain Bisimwa**\n\n- Github : [@guillainbisimwa](https://github.com/guillainbisimwa)\n- Twitter : [@gullain_bisimwa](https://twitter.com/gullain_bisimwa)\n- Linkedin : [guillain-bisimwa](https://www.linkedin.com/in/guillain-bisimwa-8a8b7a7b/)\n\n## Show your support\n\nGive a ⭐️ if you like this project!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillainbisimwa%2Ffind-house-api-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguillainbisimwa%2Ffind-house-api-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillainbisimwa%2Ffind-house-api-doc/lists"}