https://github.com/rafaelcamargo/ruby-api

ruby sinatra

Last synced: about 1 year ago
JSON representation

A microscopic Ruby/Sinatra API

README

# Ruby API
> A simple experiment with Ruby and Sinatra

[![CircleCI](https://circleci.com/gh/rafaelcamargo/ruby-api.svg?style=svg)](https://circleci.com/gh/rafaelcamargo/ruby-api)

## Contributing

1. Install [Ruby 3.0+](https://rvm.io/)

2. Clone the repo:
``` bash
git clone git@github.com:rafaelcamargo/ruby-api.git
```

3. Go to the project directory:
``` bash
cd ruby-api
```

4. Install the project dependencies:
``` bash
bundle install
```

4. Run the API:
``` bash
ruby app.rb
```
*The API will be running on http://127.0.0.1:4567*

## Tests

Ensure that all code that you have added is covered with unit tests:
``` bash
bin/rspec
```