README.md

UpVote

Click to open the UpVote app hosted on Heroku Click here to open the related Back-End API supporting this Front-End

Table of Contents

• About the Project
• Purpose
  • Built With
• Installation
  • Requirements
  • Versions
• Database
  • Programatic Flow
• Testing
  • Testing Technologies
• Roadmap
• Running Tests
• Contact
• Acknowledgements

About the project

UpVote is an interactive Rails web application built from conception to completion that authenticates with a third-party service (GitHub), consumes the Upsplash API, and provides a solution to an identified problem.

Purpose

Object Oriented Programing principles, Restful Routing, Test Driven Development, Behavior Driven Development, Authenticated API calls, OAuth process

Welcome Page Demo

Installation

1. Clone down this and the micro-service repo into a directory of your choice

  $ git clone https://github.com/jobannon/upvote_ui
  $ git clone https://github.com/jobannon/upvote_api

2. Change into the following directory

  $ cd upvote_ui

3. Install the gem packages

  $ bundle install

4. Change into the other directory

  $ cd upvote_api

5. Install the gem packages

  $ bundle install

6. Set up the database

  $ rake db:{create,migrate,seed}

7. Launch your local server

  $ rails s

8. In a separate terminal tab, run the upvote_ui

  $ cd upvote_ui
  $ puma

9. Finally, visit http://localhost:9292 in your web browser

Requirements

Environment variables and required API keys/tokens:

• GitHub client_id defined as ENV['GITHUB_KEY']
• GitHub client_secret defined as ENV['GITHUB_SECRET']

Versions

• Ruby 2.6.3
• Rails 6.0.2

Related Repositories

• upvote_api

Database

Architecture

Testing

Testing Technologies

• rspec
• factory_bot_rails
• faker
• pry
• capybara
• shoulda-matchers
• simplecov
• webmock

Running Tests

Run the full test suite:

$ bundle exec rspec

Run a single test file:

$ bundle exec rspec <path-to-file>

Roadmap

• projectboard

Contact

• jobannon
• freeheeling
• hale4029

Acknowledgements

• Brian Zanti