Skip to content
No description, website, or topics provided.
Ruby HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib
log
public
spec
tmp
.gitignore
.rspec
.yardopts
Gemfile
Gemfile.lock
Guardfile
LICENSE
README.md
Rakefile
config.ru

README.md

Spotty

A very social spot guide. This is a Rails 5 API application. Its built to work in conjunction with a front-end Javascript SPA.

Authentication

This app is built on stateless authentication with JWT. There is no session middleware.

Requirements

  • Postgres 9.5+
  • Ruby 2.3.1

Documentation

API documentation is available at http://www.rubydoc.info/github/maxcal/spotty/master. This project is documented with YARD.

You are encouraged to write documentation for all public methods. You can run a live version of the docs server with:

  yard server -s webrick --reload

Testing

This app embraces Behavior Driven development. Specs are written in RSpec.

The test suite can be run with bin/rspec spec or you can run a continouus testing service with bin/guard.

This app uses FactoryGirl instead of fixtures.

Guidelines

  • Test public methods.
  • Use request specs instead of controller specs.
You can’t perform that action at this time.