Skip to content
This repository has been archived by the owner on Mar 10, 2021. It is now read-only.

Latest commit

 

History

History
122 lines (93 loc) · 2.25 KB

README_INSTALL.md

File metadata and controls

122 lines (93 loc) · 2.25 KB
Raw

Thesis - Manual Installation

For automatic setup, see README.md.

1. Add thesis to your mix.exs:

def deps do
  [{:thesis, "~> 0.3.0"}]
end

def application do
  [applications: [:thesis]]
end

Run mix deps.get.

2. Update your config/config.exs

config :thesis,
  store: Thesis.EctoStore,
  authorization: <MyApp>.ThesisAuth,
  uploader: Thesis.RepoUploader
config :thesis, Thesis.EctoStore, repo: <MyApp>.Repo
# If you want to allow creating dynamic pages:
# config :thesis, :dynamic_pages,
#   view: <MyAppWeb>.PageView,
#   templates: ["index.html", "otherview.html"],
#   not_found_view: <MyAppWeb>.ErrorView,
#   not_found_template: "404.html"

3. Create lib/YOURAPP/thesis_auth.ex

defmodule <MyApp>.ThesisAuth do
  @behaviour Thesis.Auth

  def page_is_editable?(conn) do
    true # editable by the world
  end
end

4. Generate a migration

defmodule <MyApp>.Repo.Migrations.CreateThesisTables do
  @moduledoc false
  use Ecto.Migration

  def change do
    create table(:thesis_pages) do
      add :slug, :string
      add :title, :string
      add :description, :string

      timestamps
    end

    create table(:thesis_page_contents) do
      add :page_id, :integer
      add :name, :string, nil: false
      add :content, :text,  default: "Edit this content area"
      add :content_type, :string, default: "html"
      add :meta, :text

      timestamps
    end
  end
end

5. Add Thesis to your layout

  <body>
    <%= thesis_editor(@conn) %>

6. Run mix ecto.migrate

$ mix ecto.migrate

7. Add Thesis.Controller, Thesis.View, and Thesis.Router to your lib/*_web.ex file

NOTE: This was located in web/web.ex in Phoenix 1.2 and prior.

      def controller do
        quote do
          use Phoenix.Controller
          use Thesis.Controller

          # ...
        end
      end

      def view do
        quote do
          use Phoenix.View, root: "web/templates"
          use Thesis.View

          # ...
        end
      end

      def router do
        quote do
          use Phoenix.Router
          use Thesis.Router
        end
      end

8. Done!

Now, start adding content areas. See the README.md for further instructions.