ezedepetris / place-to-park-api

Skeleton for new Rails 5 application for REST API

This simple application includes Ruby/Rails technology which we use at Flatstack for new REST API projects. Application currently based on Rails 5 stable branch and Ruby 2.5.1

What's included

Application gems:

• puma as Rails web server

Development gems

• dotenv - load environment variables from .env

Testing gems

• factory bot - create test data
• faker - generate fake data
• rspec api documentation - generate pretty API docs
• rspec - awesome, readable isolation testing
• shoulda matchers - frequently needed Rails and RSpec matchers

Scripts

• bin/setup - build Docker image and prepare DB
• bin/server - to run server locally
• bin/ci - runs RSpec tests and quality tools

Quick start

Clone application as new project with original repository named "place-to-park-api"

git clone git://github.com/ezedepetris/place-to-park-api.git --origin place-to-park-api [MY-NEW-PROJECT]

Create your new repo on GitHub and push master into it. Make sure master branch is tracking origin repo.

git remote add origin [e-mail]:[MY-GITHUB-ACCOUNT]/[MY-NEW-PROJECT].git
git push -u origin master

Run setup script

bin/setup

Make sure all test are green

bin/ci