https://github.com/jaxgeller/open-ipsum-api

Open Ipsum API
https://github.com/jaxgeller/open-ipsum-api

Last synced: 16 days ago
JSON representation

Open Ipsum API

• Host: GitHub
• URL: https://github.com/jaxgeller/open-ipsum-api
• Owner: jaxgeller
• Created: 2015-05-20T21:47:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-13T15:14:50.000Z (almost 9 years ago)
• Last Synced: 2023-09-19T18:47:06.290Z (over 1 year ago)
• Language: Ruby
• Homepage: https://openipsum.com
• Size: 163 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/jaxgeller/open-ipsum-api.svg?branch=master)](https://travis-ci.org/jaxgeller/open-ipsum-api)

# Open Ipsum API

This is the API backing to [openipsum.com](https://openipsum.com). It is built using Rails-api.

Checkout the UI for this api [here](https://github.com/jaxgeller/open-ipsum-ui)

## Using the API

The host for the API is `https://api.openipsum.com`, __all requests must be made over https.__

## Endpoints

```

GET    /ipsums      Get all ipsums

POST   /ipsums      Create an ipsum

GET    /ipsums/:id  Get specific ipsum

Put    /ipsums/:id  Update an ipsum

DELETE /ipsums/:id  Delete an ipsum

GET    /search      Search by text and title

POST   /users       Create user

GET    /users/:id   Get a specific user

PUT    /users/:id   Update a user

DELETE /users/:id   Delete a user

POST   /signin      Signs in a user

DELETE /signout     Signs out a user

```

## Contributing

If you find any bugs or would like to ask for features, please open an issue.

Otherwise details for running this application can be found below.

### Prerequisites

You will need the following things properly installed on your computer.

* Ruby 2.2.3

* Rails 4.2.5

* Postgresql

### Installation

* `git clone https://github.com/jaxgeller/open-ipsum-api` this repository

* change into the new directory

* `bundle`

* `rake db:reset`

### Running / Development

* `rails server`

### Bootstrap an Ubuntu Server

Run the init scripts

```

curl -o run.sh https://raw.githubusercontent.com/jaxgeller/open-ipsum-api/master/deployment/bootstrap.sh && \

chmod +x run.sh && \

./run.sh

```