devekkoio/brando

^{A helping hand.}

*EXPERIMENTAL, NOT RECOMMENDED TO USE BEFORE IN MORE STABLE FORM!*

Install

Start by creating a new Phoenix project:

$ mix phx.new my_project

Run the install script:

$ wget https://raw.githubusercontent.com/brandocms/brando/master/install.sh && chmod +x install.sh && ./install.sh

Go through config/brando.exs.

To use Brando's error view, add to your Endpoint's config (in prod.exs):

config :my_app, MyApp.Endpoint,
  render_errors: [accepts: ~w(html json), view: Brando.ErrorView, default_format: "html"],

Remember to switch out your ports and configure SSL in etc/nginx/prod.conf

Dependencies

sharp/sharp-cli for image processing. Installation instructions: brandocms#183
gifsicle for GIF resizing.

Datasources

The content editor can access datasources from the frontend.

First register the datasource in your schema:

  use Brando.Datasource

  datasource :list, %{
    shareholders: &MyApplication.Shares.list_shareholders/0
  }

It's important that the create, update and delete functions in your context file calls Brando.Datasource.update_datasource(<schema>, entry)

Examples here:

  @doc """
  Create new artist
  """
  @spec create_artist(params, user | :system) :: {:ok, Artist.t()} | {:error, Ecto.Changeset.t()}
  def create_artist(artist_params, user \\ :system) do
    with changeset <- Artist.changeset(%Artist{}, artist_params, user),
         {:ok, entry} <- Repo.insert(changeset) do
      Brando.Datasource.update_datasource(Artist, entry)
    else
      err -> err
    end
  end

  @doc """
  Update existing artist
  """
  @spec update_artist(id, params, user | :system) ::
          {:ok, Artist.t()} | {:error, Ecto.Changeset.t()}
  def update_artist(artist_id, artist_params, user \\ :system) do
    with {:ok, artist} <- get_artist(artist_id),
         changeset <- Artist.changeset(artist, artist_params, user),
         {:ok, entry} <- Repo.update(changeset) do
      Brando.Datasource.update_datasource(Artist, entry)
    else
      err -> err
    end
  end

  @doc """
  Delete artist by id
  """
  @spec delete_artist(id) :: {:ok, Artist.t()}
  def delete_artist(id) do
    {:ok, entry} = get_artist(id)
    Repo.delete(entry)
    Brando.Datasource.update_datasource(Artist, entry)
  end

I18n

Brando uses Gettext for i18n.

To extract your frontend translations:

$ mix gettext.extract

Create your frontend translation directories: (for norwegian)

$ mkdir -p priv/gettext/frontend/no/LC_MESSAGES

Merge frontend translations

$ mix gettext.merge priv/gettext/frontend --plural-forms=2

Generator

Generate templates:

$ mix brando.gen

Serve static from DO Spaces

Setup Endpoint for prod.exs

config :my_app, hmr: false
config :my_app, MyAppWeb.Endpoint,
  static_url: [
    scheme: "https",
    host: "cdn.univers.agency",
    path: "/my_app/static",
    port: 443
  ]

config :ex_aws, :s3, %{
  access_key_id: System.get_env("AWS_ACCESS_KEY_ID"),
  secret_access_key: System.get_env("AWS_SECRET_ACCESS_KEY"),
  scheme: "https://",
  host: %{"fra1" => "SPACES_NAME.fra1.digitaloceanspaces.com"},
  region: "fra1"
}

Use Brando.HTML.include_js/0 and Brando.HTML.include_css/0 right before </head> in app.html.eex, since these functions automatically chooses whether to use path or url for static asset links.

Add to your frontend package.json

"build": "webpack --mode=production --config webpack.prod.js",
"build:cdn": "BRANDO_CDN=<%= application_name %> NODE_ENV=production webpack --mode=production --config ./webpack.config.prod.js",

Make sure you build frontend with:

RUN yarn run build.cdn

Add to Dockerfile build:

$ mix brando.static.deploy

Villain modules

Naming conventions

<!-- header block next to text block -->
<article b-tpl="header|text">

<!-- image with full bleed -->
<article b-tpl="image+bleed">

<!-- body text with an image underneath -->
<article b-tpl="body/image">

You may reference other fragments by entering

{% fragment index 01_intro en %}
            ^     ^        ^
            |     |        `-- language
            |     `-- fragment key
            `-- parent key

Releases

Brando uses distillery through Docker for release management.

Use the fabric script in fabfile.py for deploying and controlling.

# fab prod -l

Sequence

Implements schema sequencing.

Schema:

+ use Brando.Sequence.Schema

  schema "schema" do
    # ...
+   sequenced
  end

Migration:

+ use Brando.Sequence.Migration

  def up do
    create table(:schema) do
      # ...
+     sequenced
    end
  end

Admin channel:

+ use Brando.Sequence.Channel

+ sequence "employees", MyApp.Employee

Lockdown

If you want to limit the availability of your site while developing, you can use the Brando.Plug.Lockdown plug.

If you are authenticated, the website loads normally.

Example

    plug Brando.Plug.Lockdown, [
      layout: {MyApp.LockdownLayoutView, "lockdown.html"},
      view: {MyApp.LockdownView, "lockdown.html"}
    ]

Configure

    config :brando,
      lockdown: true,
      lockdown_password: "my_pass",
      lockdown_until: ~N[2016-08-02 19:00:00]

Password and time is optional.

If no password configuration is found, you have to login through the backend to see the frontend website.

You can also add a key as query string to set a cookie that allows browsing.

http://website/?key=<pass>

Page fragments

Example:

import Brando.Pages, only: [fetch_fragment: 2]

fetch_fragment("my/fragment", Gettext.get_locale(MyApp.Gettext)
fetch_fragment("my/fragment", "en")

If no language is passed, default language set in brando.exs will be used. If the fragment isn't found, it will render an error box.

Imagefield

A built in method for adding images to your schema is supplied for you.

In your schema:

+ use Brando.Field.Image.Schema

  schema "user" do
    field :username, :string
+   field :avatar, Brando.Type.Image
  end

+ has_image_field :avatar, %{
+   allowed_mimetypes: ["image/jpeg", "image/png", "image/gif"],
+   default_size: "medium",
+   upload_path: Path.join("images", "avatars"),
+   random_filename: true,
+   size_limit: 10_240_000,
+   sizes: %{
+     "micro"  => %{"crop" => false, "quality" => 10, "size" => "25"},
+     "thumb"  => %{"size" => "150x150>", "quality" => 100, "crop" => true},
+     "small"  => %{"size" => "300", "quality" => 100},
+     "medium" => %{"size" => "500", "quality" => 100},
+     "large"  => %{"size" => "700", "quality" => 100},
+     "xlarge" => %{"size" => "900", "quality" => 100}
+   }
+ }

The migration's field should be :text, not :string.

Deployment

Requires fabric.

Configure ./fabfile.py with your own values.

Make sure your local Docker machine is running, and that the env has been prepared:

$ docker-machine start default
$ eval "$(docker-machine env default)"

Ensure that @version "0.X.0" is set as module attribute in your mix.exs file.

Run

$ fab prod bootstrap_release

to deploy on your production box.

To build a new release

$ fab prod deploy_release

To seed your DB:

$ fab prod seed

To dump local db to .sql

$ fab dump_localdb

To upload local db to remote

$ fab prod upload_db

To load remote db

$ fab prod load_db

To dump/upload/load local db to remote:

$ fab prod dump_and_load_db

To upload your local media/ folder (only runs if remote media/ doesn't exists!)

$ fab prod upload_media

To upload your local etc/ folder

$ fab prod upload_etc

devekkoio / brando