Build StatusHex pmCoverage Status

VerkWeb

Web interface for Verk

Installation

First, add Verk Web to your mix.exs dependencies:

def deps do
[{:verk_web, "~> 0.9"},
{:verk, "~> 0.9"}]
end

and run

$ mix deps.get

Now, list :verk_web and :verk applications as your application dependencies. They must run together on the same node.

def application do
[applications: [:verk_web, :verk]]
end

If you'd like to mount VerkWeb on another Endpoint:

defmodule MyApp.Endpoint do
use VerkWeb.Mount, path: "/verk"
...
end

That should be it! :)

If you'd like to run VerkWeb as stand-alone Endpoint on a different port than the main application:

# in config.exs:
config :verk_web, VerkWeb.Endpoint,
http: [port: 4000],
server: true #-> this is to tell VerkWeb to start a standalone application!

Now VerkWeb would run on port 4000,

What it looks like

Development

To start Verk Web app:

  1. Install dependencies with mix deps.get
  2. Install front-end dependencies npm install && bower install
  3. Start Phoenix endpoint with mix phoenix.server

Now you can visit localhost:4000 from your browser.