Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.36 KB

README.md

File metadata and controls

31 lines (23 loc) · 1.36 KB

Pocket Rails

A Pocket clone written soley as a Rails 5 API.

Build Status Test Coverage Maintainability

API Documentation

To view the API docs go to the ApiaryIO Site

Demo

You can practice hitting the API on the staging site

Development

This guide assumes you have docker-compose installed on your system

To set up your environment: bin/init

Services provided

Web

This service starts the Rails server or execute arbitrary rails tasks in the development Rails environment localhost:80 is forwarded to localhost:3000

Starting the server: docker-compose up -d Attaching to the server: docker attach <container> Running rails tasks: docker-compose run web rails task:name Running RSpec: docker-compose run web rspec path/to/test

Postgres

This service is the datastore, uses the default Postgres image localhost:5432 is exposed for direct db access