Welcome To quickQuote Documentation!

This site covers quickQuote’s documentation. For basic info on what quickQuote is, as well as a live demo, and user manual please see the main project website - times.github.io/quickQuote
.

System Manual

Here is a step by step plan on how to install quickQuote. It will get you to a point of having a deployed instance on Heroku.

Prerequisite

You will need to have the following installed

ruby

ruby on rails

Git

Git installed locally

Github

Heroku

Heroku account

Heroku installed locally

ffmpeg (for running development version locally)

MySql

MySql

Sequel Pro

Showing how to install these is behiond the scope of this system manual.

System dependencies

a list of most relevant system dependencies

ruby version 2.0.0

rails version 4.2.0

ffmpeg version 2.7.1

--enable-shared

--enable-pthreads

--enable-gpl

--enable-version3

--enable-hardcoded-tables

--enable-avresample

--cc=clang

--host-cflags=

--host-ldflags=

--enable-libx264

--enable-libmp3lame

--enable-libvo-aacenc

--enable-libxvid

--enable-libvorbis

--enable-libvpx

--enable-vda

Video js 4.12.8 cdn

jquery 3.0.0-alpha1 cdn

bootswatch paper bootstrap.min.css 3.3.5 cdn

ajax jquery 1.11.2 cdn

bootstrap js 3.3.5 cdn

see Gemfile for list of rails gem dependencies.

Configuration

API keys

You'll need to make the following accounts to get the API keys

amazon S3

production

development

spoken data API

production

development

Google API

production

development

local mysql database for testing - optional

If not using Heroku, but deploying Heroku style, for instance on Deis, you'll also need a separate database. optional

amazon RDS

production

development

spoken data

Getting two API keys for spoken data requires two email address to make two distinct account(or 3 if you want only for testing), if you prefer you can just use one account for production and development, but I'd advise against as it can get messy quickly if you try to distinguish on their dashboard which videos you uploaded in development and which once are your users.

Google API key

In the Google developer console, create a new project, and get the client id and client secret.

You'll need a URI for the deployed application and one for development.
Google does not support adding localhost, so you'll need to setup a custom local url.
explained below

Local domain name for use in development

For use during developemeant it requires to setup a local DNS for your local host address that maps to your localhost.

In terminal

$ sudo nano /etc/hosts

in the hosts file

127.0.0.1localhost**yourlocaldomainname**.com

You can use same details for development and testing.
This needs to be added to the Google Console API as the redirect URL.
so that in config/application.yml you can set the environment variable to be:

Deployment instructions

Then run one of the deployment scripts.
Before running the script, inspect the script to costumise the deployment to your needs, and make sure it does what expected, I take no responsability for these 3 deployment script.

When deploying the application for the first time run.

$ ./first_time_deploy.sh

For subsequent deployments you can use

$ ./deploy.sh

If after the first deployment you want to deploy as new application run

$ new_deploy.sh

Note that this last one, does not delete the previous application, it simply removes the git remote.
if you wish to delete it, you'd need to run heroku apps:destroy --app $app --confirm $app where $app is the name of the app you want to delete. Alternatively you can log in to you Heroku account and delete it from there.