Project Title

Genevieve Viewing party descriptions. Ensure we have a blurb about the API consumption from Movie DB.

Mention about using bcrypt for protecting user data and how it's in gemfile and configuration. If you want to use another tool do this to pull it out.

Authors

• Harrison Blake
• Jacob Arellano
• Genevieve Nuebel

See also the list of Contributors who participated in this project.

Summary

• Getting Started
• Database Normalization
• Running the test suite
• Deployment
• Built With
• How to Contribute
• Roadmap
• Contributors
• Acknowledgments

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Ruby

  • The project is built with rubyonrails using ruby version 2.5.3p105, you must install ruby on your local machine first. Please visit the ruby home page to get set up. Please ensure you install the version of ruby noted above.

• Rails

  gem install rails --version 5.2.4.3

• Postgres database

  • Visit the postgresapp homepage and follow their instructions to download the latest version of Postgres.app.

• Movie DB API

  • This project consumes an API from The Movie DB. You need to setup your own account and request an API key in order to use this app. This API key should never be exposed and is hidden using the figaro gem, see installation instructions for more details on how to configure.

Installing

1. Clone the repo

   git clone https://github.com/harrison-blake/viewing_party

2. Bundle Install

   bundle install

3. Create rails database and migrate

$ rails db:create
$ rails db:migrate

4. Configure your API key environmental variable. Run the below command to create an application.yml that is included in the .gitignore file.

$ bundle exec figaro install

5. Open the application.yml file in your text editor, in the example below it is using atom as the text editor.

$ atom config/application.yml

6. Inside of the application.yml create environment variable for your Movie DB api key. At the bottom of the file enter the following:

MOVIE_API: <your api key goes here>

7. Start rails server

$ rails s

Database Normalization

Jacob

DB Schema

Database Design

Self Referential Relationships for Friends Table

Type some stuff

Running the test suite

Genevieve The tests are all built using the RSpec and Capybara test suites.

Deployment

Add additional notes about how to deploy this on a live system Harrision

Built With

• Ruby on Rails
• HTML
• JavaScript
• CoffeeScript
• Bootstrap

How to Contribute

In the spirit of Viewing Party, things done together are better than done on our own. If you have any amazing ideas or contributions on how we can improve this app they are greatly appreciated. To contribute:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Roadmap

See the open issues for a list of proposed features (and known issues). Please open an issue ticket if you see an existing error or bug.

Contributors

• Harrison Blake

• Jacob Arellano

• Genevieve Nuebel

  See also the list of contributors who participated in this project.

Acknowledgments

-- Billie Thompson - Provided README Template - PurpleBooth

• Our fantastically amazing instructors at Turing School of Software and Design:
  • Ian Douglas
  • Alex Robinson
  • Tim Tyrell