tolaria 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6bbe4f07c4384a212775e975ce8eb3ebdc9bac7
+  data.tar.gz: 7c73d1de0b10a9e9b66245132190eea2c1671287
+SHA512:
+  metadata.gz: ef6b210ab9493676b17282ba7f9f15ee1bd072e6f679cda2cfde50fdc7464cc1109ff97d51c7d3486428359869bd1387847cccfa817e9bfed089d093c2fcb6a0
+  data.tar.gz: 17f7e9f64856fcd583071c69da4e5ad02ea6ad411758e06bb69c175b49b0a0f580b0fd81c9f9b8198491879f7196a945677aa4da5bab022525d88104dc773e29

data/.gitignore

@@ -0,0 +1,66 @@
+# Special ignores for this project
+
+Gemfile.lock
+
+# Ignore local dev only files
+
+*.dump
+*.gem
+*.log
+*.rbc
+*.cache
+*.pid
+*.sqlite3
+*.sqlite3-journal
+.bundle
+.config
+.env
+.env.test
+.yardoc
+config/database.yml
+coverage
+export
+InstalledFiles
+lib/bundler/man
+node_modules
+pkg
+public/system/**/*
+rdoc
+doc
+rerun.txt
+spec/reports
+spec/tmp/**/*
+tags
+test/tmp
+test/version_tmp
+vendor/**/*
+vim/.netrwhist
+zeus.json
+_yardoc
+
+# Ignore compilation junk
+
+**.orig
+*.rbc
+*.sassc
+*.sw[nop]
+.rspec
+.sass-cache
+capybara-*.html
+pickle-email-*.html
+rerun.txt
+
+# Ignore filesystem trash
+
+*.DS_Store
+*Thumbs.db
+.DS_Store?
+ehthumbs.db
+Thumbs.db
+
+# Specifically DO NOT ignore these repo settings
+
+!.gitignore
+!.slugignore
+!.ruby-version
+!.yardops

data/.yardopts

@@ -0,0 +1,4 @@
+--readme README.md
+--charset utf-8
+--markup markdown
+--exclude /test

data/CNAME

@@ -0,0 +1 @@
+tolaria.threespot.com

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+The Tolaria team welcomes contributions. While contributing, you must adhere to the project [code of conduct](#the-code-of-conduct), so that everyone feels welcome.
+
+Here’s how you can make Tolaria better:
+
+  - Use prerelease versions (`gem install tolaria --pre`)
+  - [Report an issue](https://github.com/threespot/tolaria/issues/new) or ask questions
+  - [Suggest new features](https://github.com/threespot/tolaria/issues/new)
+  - Check, vet, diagnose, or add details to existing issues.
+  - Contributing or improving documentation. We’re sure there are still typos or unclear instructions. These are easy wins.
+  - Contributing pull requests or bugfixes.
+
+**Please note:** Tolaria is not necessarily the team’s full-time gig. Please be patient with us getting back to you.
+
+Thanks for helping us make Tolaria better!
+
+### The Code of Conduct
+
+Tolaria strongly values contributors from anywhere, regardless of gender, gender expression, sexual orientation, ability, physical appearance, body type, race, age, or religion. As a result, the team has agreed to and enforces this code of conduct in order to provide a harassment-free experience for everyone who participates in the development of Tolaria.
+
+Harassment includes offensive comments related to gender, gender expression, sexual orientation, ability, physical appearance, body type, race, age, or religion. It also includes the posting of sexual images, deliberate intimidation, stalking, and unwelcome sexual attention.
+
+Further, harassment includes ad-hominem attacks, grandstanding, derogatory comments, trolling, public or private community disruption, insults, or other unprofessional conduct.
+
+Harassment is not tolerated in our issue tracker, code, events, chat channels, over emails, or any other way you can communicate with a contributor. Anyone who is asked to cease harassment is expected to comply immediately. Our team is not exempt from this policy.
+
+If anyone engages in harassing behavior, we may take appropriate action, up to and including warning the offender, deletion of comments, removal from the project’s codebase and communication systems, and escalation to GitHub support.
+
+If you are being harassed, notice that someone else is being harassed, or have any other concerns, please open an issue or contact a team member.
+
+### License
+
+This document is published from the United States. To the extent possible under law, Threespot Media has waived all copyright and related or neighboring rights to this document worldwide. The text may be re-used for any purpose and without credit.

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.md

@@ -0,0 +1,9 @@
+### The MIT License
+
+Copyright (c) 2015 Threespot Media
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,538 @@
+## Tolaria
+
+Tolaria is a [content management system](https://en.wikipedia.org/wiki/Content_management_system) (CMS) framework for [Ruby on Rails](https://en.wikipedia.org/wiki/Ruby_on_Rails). It greatly speeds up the necessary—but repetitive—task of creating useful admin panels, forms, and model workflows for site authors.
+
+[![](https://cloud.githubusercontent.com/assets/769083/8262095/ccb2b68e-169d-11e5-9378-0d098eb22c22.png)](https://cloud.githubusercontent.com/assets/769083/7573791/56eda172-f7f6-11e4-8df7-36015cf5cf85.png)
+
+[![](https://cloud.githubusercontent.com/assets/769083/8262101/d64a4478-169d-11e5-879e-4927640c5f39.png)](https://cloud.githubusercontent.com/assets/769083/7573968/cc448ebc-f7f7-11e4-8593-c6465d3a8e3c.png)
+
+### Features
+
+- Fully responsive (and we think it's beautiful too!)
+- A complete email-based authentication system is included, and there are no passwords to manage.
+- Automatically builds navigation and admin routes for you.
+- Automatically creates simple index screens, show screens, and text search tools, which you can expand.
+- Includes a handful of advanced form fields, notably a fullscreen Markdown editor and searchable select/tag lists.
+- Assists in providing inline help and documentation to your editors.
+- No magic DSL. Work directly in ERB on all admin views.
+- Compartmentalized from the rest of the Rails application, and does not rely on the behavior of `to_param`.
+- Easily overridable on a case-by-case basis.
+- Designed for use on Heroku, in containers, and on websites with TLS.
+- Modest dependencies.
+
+### Browser Support
+
+Tolaria supports IE10+, Safari, Chrome, Firefox, iOS, and Chrome for Android. Note that these are the browsers your site editors will need, not the general site audience, which can differ.
+
+### Getting Started
+
+Add Tolaria to your project's `Gemfile`:
+
+```ruby
+gem "tolaria"
+```
+
+Then update your bundle.
+
+Now run the installation generator. This will create an initializer for Tolaria plus a migration to set up an `administrators` table. Migrate your database.
+
+```shell
+$ rails generate tolaria:install
+$ rake db:migrate
+```
+
+Review all of the settings in `config/initializers/tolaria.rb`.
+
+Run this Rake command to create your first administrator account:
+
+```shell
+$ rake admin:create
+```
+
+Now you'll need to add Tolaria's route drawing to the top of your `routes.rb` file like so:
+
+```ruby
+Rails.application.routes.draw do
+  Tolaria.draw_routes(self)
+  # Your other routes below here
+end
+```
+
+Tolaria needs to be able to dispatch email. You'll need to configure ActionMailer to use an appropriate mail service. Here's an example using [Mailgun on Heroku](https://devcenter.heroku.com/articles/mailgun):
+
+```ruby
+# config/initializers/action_mailer.rb
+
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.delivery_method = :smtp
+
+ActionMailer::Base.smtp_settings = {
+  port: ENV.fetch("MAILGUN_SMTP_PORT"),
+  address: ENV.fetch("MAILGUN_SMTP_SERVER"),
+  user_name: ENV.fetch("MAILGUN_SMTP_LOGIN"),
+  password: ENV.fetch("MAILGUN_SMTP_PASSWORD"),
+  domain: "example.org",
+  authentication: :login,
+  enable_starttls_auto: true,
+}
+```
+
+Now start your Rails server and go to `/admin` to log in!
+
+### Adding Administrator Accounts
+
+You can add administrators from the command line using a Rake task. This is particularly useful for creating the very first one.
+
+```shell
+$ rake admin:create
+```
+
+If you are already logged in to Tolaria, you can also simply visit `/admin/administrators` to create a new account using the CMS interface.
+
+### Passcode Authentication
+
+Tolaria authenticates editors via email, using a one-time passcode. When an editor wants to sign in, they must type a passcode dispatched to their email address. Passcodes are invalidated after use.
+
+You can configure Tolaria's passcode paranoia in the initializer you installed above.
+
+![](https://cloud.githubusercontent.com/assets/769083/8137572/5e81bb1e-1112-11e5-9626-fc7a0010f0c4.png)
+
+### Managing a Model
+
+Inside your ActiveRecord definition for your model, call `manage_with_tolaria`, passing configuration in the `using` Hash. [Refer to the documentation for all of the options](#FIXME).
+
+The icon system uses [Font Awesome][fa], and you'll need to pass one of [the icon names][fa] for the `icon` key.
+
+[fa]: http://fontawesome.io/icons/
+
+**Important:** you'll need to provide the options to pass to `params.permit` here for the admin system. Your form won't work without it!
+
+```ruby
+class BlogPost < ActiveRecord::Base
+  manage_with_tolaria using: {
+    icon: "file-o",
+    category: "Settings",
+    priority: 5,
+    permit_params: [
+      :title,
+      :body,
+      :author_id,
+    ]
+  }
+end
+```
+
+### Customizing Indexes
+
+By default, Tolaria will build a simple index screen for each model. You'll likely want to replace it for complicated models, or to allow administrators to sort the columns.
+
+If your model was `BlogPost`, you'll need to create a file in your project at: `app/views/admin/blog_posts/_index.html.erb`.
+
+See the [TableHelper documentation](#FIXME) for more information.
+
+```erb
+<% # app/views/admin/blog_posts/_index.html.erb %>
+
+<%= index_table do %>
+  <thead>
+    <tr>
+      <%= index_th :id %>
+      <%= index_th :title %>
+      <%= index_th "Author", sort: false %>
+      <%= actions_th %>
+    </tr>
+  </thead>
+  <tbody>
+    <% @resources.each do |blog_post| %>
+      <tr>
+        <%= index_td blog_post, :id %>
+        <%= index_td blog_post, :title %>
+        <%= index_td blog_post, blog_post.author.name, image:blog_post.author.portrait_uri %>
+        <%= actions_td blog_post %>
+      </tr>
+    <% end %>
+  </tbody>
+<% end %>
+```
+
+### Customizing The Inspect Screen
+
+Tolaria provides a very basic show/inspect screen for models. You'll want to provide your own for complex models.
+
+If your model was `BlogPost`, you'll need to create a file in your project at: `app/views/admin/blog_posts/_show.html.erb`.
+
+See the [TableHelper documentation](#FIXME) for more information.
+
+```erb
+<% # app/views/admin/blog_posts/_show.html.erb %>
+
+<%= show_table do %>
+
+  <thead>
+    <%= show_thead_tr %>
+  </thead>
+  <tbody>
+    <%= show_tr :title %>
+    <%= show_tr "Author", @resource.author.name %>
+    <%= show_tr :body %>
+  </tbody>
+
+<% end %>
+```
+
+### Adding Model Forms
+
+Tolaria does not build editing forms for you, but it attempts to help speed up your work by providing a wrapper.
+
+If your model was `BlogPost`, you'll need to create a file in your project at  `app/views/admin/blog_posts/_form.html.erb`. You'll provide the form code that would appear inside the `form_for` block, excluding the submit buttons. The builder variable is `f`.
+
+```erb
+<% # app/views/admin/blog_posts/_form.html.erb %>
+
+<%= f.label :title %>
+<%= f.text_field :title, placeholder:"Post title" %>
+<%= f.hint "The title of this post. A good title is both summarizing and enticing, much like a newspaper headline." %>
+
+<%= f.label :author_id, "Author" %>
+<%= f.searchable_select :author_id, Author.all, :id, :name, include_blank:false %>
+<%= f.hint "Select the person who wrote this post." %>
+
+<%= f.label :body %>
+<%= f.markdown_composer :body %>
+<%= f.hint "The body of this post. You can use Markdown!"
+```
+
+### Has-many Nested Forms
+
+If you want to provide an interface for a `has_many` + `accepts_nested_attributes_for` relationship, you can use the `has_many` helper. The UI allows slating persisted objects for removal when the form is saved.
+
+**Important**: You need to include `f.has_many_header` to create the form headers and turn on or off the destruction controls with `allow_destroy`.
+
+```erb
+<%= f.has_many :footnotes do |f| %>
+
+  <%= f.has_many_header allow_destroy:true %>
+
+  <%= f.label :description %>
+  <%= f.text_field :description %>
+  <%= f.hint "The name or other description of this reference" %>
+
+  <%= f.label :url, "URL" %>
+  <%= f.text_field :url, class:"monospace" %>
+  <%= f.hint "A full URL to the source or reference material" %>
+
+<% end %>
+```
+
+![](https://cloud.githubusercontent.com/assets/769083/8117475/50e5d0e2-1056-11e5-87a6-07bc7458da1e.png)
+
+Don't forget that you also need to change `permit_params` so that you include your nested attributes:
+
+```ruby
+class BlogPost < ActiveRecord::Base
+  manage_with_tolaria using: {
+    icon: "file-o",
+    category: "Settings",
+    priority: 5,
+    permit_params: [
+      :title,
+      :body,
+      :author_id,
+      :footnotes_attributes: [
+        :id,
+        :_destroy,
+        :url,
+        :description,
+      ]
+    ]
+  }
+end
+```
+
+### Customizing The Search Form
+
+By default, Tolaria provides a single search field that searches over all of the text or character columns of a model. You can expand the search tool to include other facets.
+
+**Important:** This system uses the [Ransack gem][ransack], which you'll need to familiarize yourself with.
+
+If your model was `BlogPost`, you'll need to create a file in your project at  `app/views/admin/blog_posts/_search.html.erb`. You'll provide the form code that would appear inside the `search_form_for` block, excluding the submit buttons. The builder variable is `f`.
+
+```erb
+<% # app/views/admin/blog_posts/_search.html.erb %>
+
+<%= f.label :title_cont, "Title contains" %>
+<%= f.search_field :title_cont, placeholder:"Anything" %>
+
+<%= f.label :author_name_cont, "Author is" %>
+<%= f.searchable_select :author_name_cont, Author.all, :name, :name, prompt:"Any author" %>
+
+<%= f.label :body_cont, "Body contains" %>
+<%= f.search_field :body_cont, placeholder:"Anything" %>
+```
+
+[ransack]: https://github.com/activerecord-hackery/ransack
+
+### Provided Form Fields
+
+You can use all of the Rails-provided fields on your forms, but Tolaria also comes with a set of advanced, JavaScript-backed fields. Make sure to [review the documentation for the form builder](#FIXME) to get all the details.
+
+#### Markdown Composer
+
+The [`markdown_composer` helper](#FIXME) will generate a very fancy Markdown editor, which includes text snippet tools and a fullscreen mode with live previewing.
+
+**Important:** You cannot use this field properly if you do not set up `Tolaria.config.markdown_renderer`. Without it, the live preview will only use `simple_format`!
+
+```
+<%= f.label :body %>
+<%= f.markdown_composer :body %>
+<%= f.hint "The body of this post. You can use Markdown!" %>
+```
+
+![markdown_composer](https://cloud.githubusercontent.com/assets/769083/7888521/407d0116-0607-11e5-91fe-a046c22ea777.png)
+
+#### Searchable Select
+
+The [`searchable_select` helper](#FIXME) displays a [Chosen select field](http://harvesthq.github.io/chosen/) that authors can filter by typing.
+
+```
+<%= f.label :title, "Topics" %>
+<%= f.searchable_select :topic_ids, Topic.order("label ASC"), :id, :label, multiple:true %>
+<%= f.hint "Select each topic that applies to this blog post" %>
+```
+
+![searchable_select](https://cloud.githubusercontent.com/assets/769083/7888524/41aba54c-0607-11e5-9c5f-483b5ecf5ea9.png)
+
+#### Image Association Select
+
+The [`image_association_select` helper](#FIXME) displays a `searchable_select` that provides an instant preview of the currently selected model as an image.
+
+```erb
+<%= f.label :featured_image_id, "Featured Image" %>
+<%= f.image_association_select :featured_image_id, Image.order("title ASC"), :id, :title, :preview_uri %>
+<%= f.hint "Select a featured image for this blog post." %>
+```
+
+![](https://cloud.githubusercontent.com/assets/769083/8119314/a83565c2-1062-11e5-92e6-5a6bcd1bb5ea.png)
+
+#### Timestamp Field
+
+The [`timestamp_field` helper](#FIXME) displays a text field that validates a provided timestamp and recovers to a template if blanked.
+
+```erb
+<%= f.label :published_at, "Publishing Date" %>
+<%= f.timestamp_field :published_at %>
+<%= f.hint "The date this post should be published." %>
+```
+
+![timestamp_field](https://cloud.githubusercontent.com/assets/769083/7888528/4487a9b4-0607-11e5-9298-bc26116b59f0.png)
+
+#### Slug Field
+
+The [`slug_field` helper](#FIXME) allows you to show the parameterized value of a field in a given pattern preview.
+
+```erb
+<%= f.label :title %>
+<%= f.slug_field :title, placeholder:"Post title", pattern:"/blog/255-*" %>
+<%= f.hint "The title of this post." %>
+```
+
+![slug_field](https://cloud.githubusercontent.com/assets/769083/7888526/42ac965e-0607-11e5-9be6-0300f0f0f04d.png)
+
+#### Swatch Field
+
+The [`swatch_field` helper](#FIXME) validates and displays a given hexadecimal color.
+
+```erb
+<%= f.label :color %>
+<%= f.swatch_field :color, placeholder:"#CC0000" %>
+<%= f.hint "Choose a background color for this campaign">
+```
+
+![swatch_field](https://cloud.githubusercontent.com/assets/769083/7888518/3e2e1828-0607-11e5-8bca-79bdfa3b6a06.png)
+
+#### Image Field
+
+The [`image_field` helper](#FIXME) displays a button that makes uploading an image a little more pleasant than a regular `file_field`.
+
+```erb
+<%= f.label :portrait %>
+<%= f.image_field :portrait, preview_url:@resource.portrait.url(:preview) %>
+<%= f.hint "Attach a portrait of this author, at least 600×600 pixels in size. The subject should be centered." %>
+```
+
+![image_field](https://cloud.githubusercontent.com/assets/769083/7888520/3f700750-0607-11e5-952a-e81edbb58017.png)
+
+#### Attachment Field
+
+The [`attachment_field` helper](#FIXME) displays a button that makes uploading an arbirary file a little more pleasant than a regular `file_field`.
+
+```erb
+<%= f.label :portrait %>
+<%= f.attachment_field :portrait %>
+<%= f.hint "Attach a portrait of this author, at least 600×600 pixels in size. The subject should be centered." %>
+```
+
+![attachment_field](https://cloud.githubusercontent.com/assets/769083/7888501/2c5d3160-0607-11e5-8b44-9c8affaa1f8d.png)
+
+#### Field Clusters (Checkboxes and 2+ Selects)
+
+If you need to run two or more `select` controls together (like for `date_select`), or you need to group a set of checkboxes together (like for `collection_checkboxes`), you'll need to wrap the form field in `<div class="field-cluster">`:
+
+```erb
+<%= f.label :published_at, "Publishing Date" %>
+<div class="field-cluster"><%= f.date_select :published_at %></div>
+<%= f.hint "The date this post should be published." %>
+
+<%= f.label :title, "Topics" %>
+<div class="field-cluster"><%= f.collection_check_boxes :topic_ids, Topic.order("label ASC"), :id, :label %></div>
+<%= f.hint "Choose each topic that applies to this blog post" %>
+```
+
+![](https://cloud.githubusercontent.com/assets/769083/8138732/774630c2-111b-11e5-8024-bdec00ed18c4.png)
+
+#### Hints
+
+[Inline help](#FIXME) is useful for reminding administrators about what should be provided for each field. Use `f.hint` to present a hint for a field.
+
+![hint](https://cloud.githubusercontent.com/assets/769083/7888576/8d20f8a6-0607-11e5-80ea-2c8f66ad7449.png)
+
+### Customizing the Menu
+
+When you call `manage_with_tolaria`, you can provide a category and a priority like below. Items in the same category will be grouped together in the navigation menu. Items are sorted priority ascending in their group.
+
+```ruby
+class BlogPost < ActiveRecord::Base
+  manage_with_tolaria using:{
+    category: "Prose",
+    priority: 5,
+  }
+end
+```
+
+If you want to re-order the groups, you need to set an array of menu titles ahead of time in `Tolaria.config.menu_categories`:
+
+```ruby
+# config/initializers/tolaria.rb
+Tolaria.configure do |config|
+  config.menu_categories = [
+    "Prose",
+    "Animals",
+    "Settings",
+  ]
+end
+```
+
+### Adding Documentation Links
+
+You can provide documentation links in the interface header by appending to `Tolaria.config.help_links`. Add hashes to the array, with these keys:
+
+To render a Markdown file, provide a `:title`, the URL fragment `:slug`, and a `:markdown_file` path to your Markdown document. The system will automatically draw a route to this view for you and present your file, using the renderer configured in `Tolaria.config.markdown_renderer`.
+
+To link to an arbitrary route or URL, provide a `:title` and a `:link_to`. Examples below:
+
+```ruby
+# config/initializers/tolaria.rb
+
+Tolaria.configure do |config|
+
+  config.help_links << {
+   title: "Markdown Reference"
+   slug: "markdown-reference",
+   markdown_file: "/path/to/your/file.md"
+  }
+
+  config.help_links << {
+   title: "Style Guide"
+   link_to: "http://example.org/styleguide"
+  }
+
+end
+```
+
+### Patching a Controller
+
+Tolaria dynamically creates controllers for managed models, named as you would expect. If you want to replace or add to controller functionality, create the file in your parent application and patch away:
+
+If your model was `BlogPost`, you should create `app/controllers/admin/blog_posts_controller.rb`
+
+```ruby
+# app/controllers/admin/blog_posts_controller.rb
+class Admin::BlogPostsController < Tolaria::ResourceController
+  def another_method
+     # do stuff
+     # render a template
+  end
+end
+```
+
+You might want to [check out what we've done in the base ResourceController](https://github.com/Threespot/tolaria/blob/master/app/controllers/tolaria/resource_controller.rb) file so that you know what you're patching. If you override any of the existing methods, you're on your own to handle everything correctly.
+
+### Adding Your Own Styles or JavaScript
+
+If you want to add additional Sass or JavaScript to the admin system, you can create these files and then append to them as you need. Make sure that you import the base styles and JavaScript so you inherit what's already been done.
+
+`app/assets/stylesheets/admin/admin.scss`:
+
+```sass
+@import "admin/base";
+// Your code goes here
+```
+
+`app/assets/javascripts/admin/admin.js`:
+
+```javascript
+//= require admin/base
+// Your code goes here
+```
+
+### Testing and Running the Demo Server
+
+Tolaria comes with a test suite and a demo server that the test suite exercises.
+
+To run tests, first clone the repo:
+
+```shell
+$ git clone -o github git@github.com:threespot/tolaria.git
+$ cd tolaria
+```
+
+Install the development dependencies:
+
+```
+$ bundle install
+```
+
+Now in the project root, you have several `rake` tasks available:
+
+```shell
+$ rake test         # Run the tests
+$ rake admin:create # Create an admin in the demo development database
+$ rake console      # Start a Rails console with Tolaria loaded
+$ rake server       # Start a Rails Webrick server with Tolaria and some example models loaded
+```
+
+### Miscellaneous Technical Details
+
+- Tolaria is not designed for use on a production site without TLS/HTTPS configured. You must protect Tolaria sessions and cookies with TLS. Do not allow users to connect to your administrator panel over plain HTTP.
+- If you are using `Content-Security-Policy`, you will need to add `https://secure.gravatar.com` to the allowed image sources in order to display administrator avatars. All other assets bundled with Tolaria are served by the Rails asset pipeline.
+- The constant and module name `Admin` is reserved for Tolaria's use. If you add to this namespace, be sure you are not colliding with a Tolaria-provided constant.
+- The route space `/admin/**/*` is reserved for Tolaria's use. If you add routes here, be sure you are not colliding with a Tolaria-generated route.
+
+### License
+
+Tolaria is free software, and may be redistributed under the terms of the [MIT license](https://github.com/Threespot/tolaria/blob/master/LICENSE.md). If Tolaria works great for your project, [we'd love to hear about it](http://twitter.com/threespot)!
+
+### Thanks
+
+Our work stands on the shoulders of giants, and we're very thankful to the many people that made Tolaria possible either by publishing code we used, or by being an inspiration for this project.
+
+- [The ActiveAdmin team](https://github.com/activeadmin/activeadmin/graphs/contributors)
+- [The jQuery Foundation](https://jquery.org)
+- [Jeremy Ashkenas](https://twitter.com/jashkenas)
+- [The Harvest Team](https://www.getharvest.com/about/meet-the-team)
+
+### About Threespot
+
+Threespot is a design and development agency from Washington, DC. We work for organizations that we believe are making a positive change in the world. Find out more [about us](https://www.threespot.com), [our projects](https://www.threespot.com/work) or [hire us](https://www.threespot.com/agency/hire-us)!
+
+[![](https://avatars3.githubusercontent.com/u/370822?v=3&s=100)](https://www.threespot.com)