API for The Spoken Tour

This is a simple API built with Rails and for a front-end React application.

Links

clicky clicky clicky

The repo for this API's front end buddy lives here.

Find the endpoints here (you'll need a key, and prepare to be blown away by some AMAZING styling).

Setup

To get your machine and this code friendly and acquainted:

Clone this repository using your preferred method and cd into it. If you're not sure, I recommend the SSH route:

git clone git@github.com:tmikeschu/spoke-n-api.git
cd spoke-n-api
bundle install
rake db:{create,migrate}
rake route_pins:load

Testing

First things first: get a dopamine hit from a verdant test suite! Run the tests with:

bundle exec rspec

Then read the tests to get oriented with the application.

Local Development

What fun is setting up and running tests if you can't do some of your own stuff?

rails s
open http://localhost:3000

Stack

Languages: Ruby DBs: Postgresql Frameworks: Rails (API only) 5.0.1 Major Libraries: DevOps: Heroku Tools: CI: Travis CI

Style

When contributing to code, be the tofu. In other words, take on the style of the existing code. Here are some main approaches I follow:

• General Ruby and Rails best practices

Contributing

Interested in helping out?

1. Reach out to me and say hello! I'd love to hear about what you're interested in.

2. Once we've confirmed what you can work on, fork this repo and work on your masterpiece.

3. Once your work is done, squash your work to a single commit, and open a PR from your feature branch to this repo's master branch.