Skip to content

Rails app used for hosting video tutorials and classes. Serves as the base repository for a B3 project.

Notifications You must be signed in to change notification settings

turingschool-examples/watch-and-learn

Repository files navigation

Watch and Learn

This is the base repo for a project with an existing codebase used at Turing for Backend Mod 3.

Project Spec and Evaluation Rubric: https://github.com/turingschool-examples/watch-and-learn

Project Board

Students will continue to build on the existing code base using the cards within the following Github Project: https://github.com/turingschool-examples/watch-and-learn/projects/1

Learning Goals and Labels

The cards are labeled in a way that correspond to learning goals or to specific areas you might personally want to focus on.

Cards should be completed from top to bottom in the To Do column. Cards labeled good first issue are good as filler work and will allow you to practice common Rails skills.

About the Project

This is a Ruby on Rails application used to organize YouTube content used for online learning. Each tutorial is a playlist of video segments. Within the application an admin is able to create tags for each tutorial in the database. A visitor or registered user can then filter tutorials based on these tags.

A visitor is able to see all of the content on the application but in order to bookmark a segment they will need to register. Once registered a user can bookmark any of the segments in a tutorial page.

Local Setup

Clone down the repo

$ git clone

Install the gem packages

$ bundle install

Install node packages for stimulus

$ brew install node
$ brew install yarn
$ yarn

Set up the database

$ rails db:create
$ rails db:migrate
$ rails db:seed

Youtube API

This project makes use of the Youtube API.

First, obtain an API key by following steps 1 - 3 in this guide for the "Before you Start" section. When creating new credentials, make sure you choose the "API Key" option. Make sure that you follow the step to enable the Youtube Data API. Your API key will not work without that step. Note: The API requests will come from a web server & will need access to Public Data

Once you have obtained an API key and enabled the API:

  1. Run bundle exec figaro install
  2. This will create the file config/application.yml. Open that file.
  3. Append the following to that file: YOUTUBE_API_KEY: <your api key>, replacing <your api key> with the api key you just obtained.

Test Suite

You can run the test suite with:

$ bundle exec rspec

If set up correctly, and assuming you have internet access and the Youtube API is functioning correctly, you should have all passing tests.

Technologies

Versions

  • Ruby 2.4.1
  • Rails 5.2.0

About

Rails app used for hosting video tutorials and classes. Serves as the base repository for a B3 project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published