/brownfield-of-dreams

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

Primary LanguageRuby

Brownfield Of Dreams

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.

Project Board

Students were asked to continue to build on the existing code base using the cards within the following Github Project: https://github.com/turingschool-examples/brownfield-of-dreams/projects/1

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.

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