https://kinduff.github.io/dog-api/
:no_entry: [DEPRECATED] Dog API provides dog facts as a service.
https://kinduff.github.io/dog-api/
Last synced: 8 months ago
JSON representation
:no_entry: [DEPRECATED] Dog API provides dog facts as a service.
- Host: GitHub
- URL: https://kinduff.github.io/dog-api/
- Owner: kinduff
- Archived: true
- Created: 2016-10-03T01:02:49.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-14T08:35:24.000Z (almost 3 years ago)
- Last Synced: 2024-07-31T21:53:11.400Z (over 1 year ago)
- Language: Ruby
- Homepage: https://dogapi.dog
- Size: 97.7 KB
- Stars: 72
- Watchers: 4
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- public-apis - Dog Facts
- public-apis - Dog Facts
README
# :no_entry: [DEPRECATED] Active at [kinduff/dogapi.dog](https://github.com/kinduff/dogapi.dog)
# Dog API
This is the Dog API and it provides dog facts as a service dogdog :dog:
## Add to Slack
This will enable two things:
- One daily random fact posted in the channel you select.
- A Slack slash command (`/dogfact`) to retrieve a single fact on any channel.
If installation was successful you'll receive a welcome message :)
### Privacy Policy
Dog Facts is just for fun. The only data retained by Dog Facts is your team webhook url (which is required to post Dog Facts messages to your Slack). Otherwise, no data is kept.
For questions or support, please contact directly through Twitter `https://twitter.com/kinduff` or chat with me at `https://keybase.io/kinduff/chat`
## Use it as an API
**Live endpoint:** `http://dog-api.kinduff.com`
| Path | Description | Parameters
| ------------ | ------------ | ----------
| `/api/facts` | Returns an object with dog facts | `?number=5`
| `/api/facts?raw=true` | Returns one fact in plain text
## Host it yourself
First make sure you have the following dependencies installed.
- Ruby greater than 2.3.0
- SQLite3
Go ahead and clone this repository.
```
git clone git@github.com:kinduff/dog-api.git
```
Then install the dependencies.
```
bundle install
```
After that you'll need to setup your database, run the following command to run migrations and fill out your database with the latest dog facts included in the `db/seeds.rb` file.
```
rake db:setup
```
And finally, start the server by running the following command.
```
rake server
```
Or just `rake` by it self. The application should now be running in `http://localhost:4567`.
In order to run the tests, just run:
```
rake spec
```
## Why you made this?
There's a [Cat API](http://catfacts-api.appspot.com) that returns cat facts. I like cats but I like dogs more. Equilibrium must exists.
## Sources
Lot's of places, I'll list them tomorrow, mom. Also, special thanks to @screenshotjy and @RoryDuncan for their contributions.