Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 1.04 KB

README.md

File metadata and controls

25 lines (15 loc) · 1.04 KB

Linky

Linky is a link shortening web application written in Ruby on Rails. Users interact with the app via a RESTFful HTTP API. The app provides an Open API Specification that describes the API, allowing users to easily send requests via the included Swagger UI, the native Postman app or generate their own API client.

Requirements

Setup

  1. Clone this repo from Github.
  2. bundle install
  3. bin/rails db:setup ()

Usage

Running the App

Just execute bin/rails server to start the application at http://localhost:300. The root URL is set as a redirect to the Swagger UI loaded with the app's Open API Specification. The spec document itself can be viewed directly via /open_api/spec.json path.

Running the Tests

Just execute bin/rspec .