[#64] generating documentation
This commit is contained in:
Felipe Ripoll
parent
fd9d8a96fa
commit
b68acde87f
|
|
@ -4,13 +4,14 @@ fonts/icomoon.eot
|
|||
fonts/icomoon.svg
|
||||
fonts/icomoon.ttf
|
||||
fonts/icomoon.woff
|
||||
dist/sidebar_items-f62ce50de1.js
|
||||
dist/sidebar_items-3a7a458c10.js
|
||||
api-reference.html
|
||||
initial_architecture.html
|
||||
search.html
|
||||
404.html
|
||||
POABackend.html
|
||||
POABackend.Receivers.Repo.html
|
||||
POABackend.Release.Tasks.html
|
||||
POABackend.Auth.html
|
||||
POABackend.Auth.Guardian.Plug.html
|
||||
POABackend.Auth.Models.Token.html
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>404 – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Auth.Guardian.Plug – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Auth.Models.Token – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Auth.Models.User – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Auth.REST – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Auth – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.CustomHandler.REST – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.CustomHandler – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Protocol.DataType – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Protocol.Message – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Protocol.MessageType – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Protocol – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Receiver – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Receivers.Dashboard – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Receivers.DynamoDB – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Receivers.Eth.Stats – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Receivers.Repo – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend.Receivers.System.Stats – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,182 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="generator" content="ExDoc v0.18.4">
|
||||
<title>POABackend.Release.Tasks – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body data-type="modules">
|
||||
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
|
||||
|
||||
<div class="main">
|
||||
<button class="sidebar-button sidebar-toggle">
|
||||
<span class="icon-menu" aria-hidden="true"></span>
|
||||
<span class="sr-only">Toggle Sidebar</span>
|
||||
</button>
|
||||
<button class="sidebar-button night-mode-toggle">
|
||||
<span class="icon-theme" aria-hidden="true"></span>
|
||||
<span class="sr-only">Toggle Theme</span>
|
||||
</button>
|
||||
<section class="sidebar">
|
||||
|
||||
|
||||
<a href="POABackend.html" class="sidebar-projectLink">
|
||||
<div class="sidebar-projectDetails">
|
||||
<h1 class="sidebar-projectName">
|
||||
poa_backend
|
||||
</h1>
|
||||
<h2 class="sidebar-projectVersion">
|
||||
v0.1.0
|
||||
</h2>
|
||||
</div>
|
||||
|
||||
</a>
|
||||
|
||||
<form class="sidebar-search" action="search.html">
|
||||
<button type="submit" class="search-button">
|
||||
<span class="icon-search" aria-hidden="true"></span>
|
||||
</button>
|
||||
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
|
||||
</form>
|
||||
|
||||
<ul class="sidebar-listNav">
|
||||
<li><a id="extras-list" href="#full-list">Pages</a></li>
|
||||
|
||||
|
||||
<li><a id="modules-list" href="#full-list">Modules</a></li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
<div class="gradient"></div>
|
||||
<ul id="full-list" class="sidebar-fullList"></ul>
|
||||
</section>
|
||||
|
||||
<section class="content">
|
||||
<div class="content-outer">
|
||||
<div id="content" class="content-inner">
|
||||
|
||||
|
||||
<h1>
|
||||
<small class="visible-xs">poa_backend v0.1.0</small>
|
||||
POABackend.Release.Tasks
|
||||
|
||||
<a href="https://github.com/poanetwork/poa-netstats-wharehouse/blob/v0.1.0/lib/poa_backend/release/tasks.ex#L1" title="View Source" class="view-source" rel="help">
|
||||
<span class="icon-code" aria-hidden="true"></span>
|
||||
<span class="sr-only">View Source</span>
|
||||
</a>
|
||||
|
||||
</h1>
|
||||
|
||||
|
||||
<section id="moduledoc">
|
||||
<p>This module is needed when we create a release. We are using Mnesia locally so when we start create a release
|
||||
we have to create the Mnesia files there. In order to do that we have to run this <a href="#migrate/0"><code class="inline">migrate/0</code></a> function.</p>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<section id="summary" class="details-list">
|
||||
<h1 class="section-heading">
|
||||
<a class="hover-link" href="#summary">
|
||||
<span class="icon-link" aria-hidden="true"></span>
|
||||
<span class="sr-only">Link to this section</span>
|
||||
</a>
|
||||
Summary
|
||||
</h1>
|
||||
|
||||
|
||||
|
||||
<div class="summary-functions summary">
|
||||
<h2>
|
||||
<a href="#functions">Functions</a>
|
||||
</h2>
|
||||
<div class="summary-row">
|
||||
<div class="summary-signature">
|
||||
<a href="#migrate/0">migrate()</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="functions" class="details-list">
|
||||
<h1 class="section-heading">
|
||||
<a class="hover-link" href="#functions">
|
||||
<span class="icon-link" aria-hidden="true"></span>
|
||||
<span class="sr-only">Link to this section</span>
|
||||
</a>
|
||||
Functions
|
||||
</h1>
|
||||
<div class="detail" id="migrate/0">
|
||||
|
||||
|
||||
<div class="detail-header">
|
||||
<a href="#migrate/0" class="detail-link" title="Link to this function">
|
||||
<span class="icon-link" aria-hidden="true"></span>
|
||||
<span class="sr-only">Link to this function</span>
|
||||
</a>
|
||||
<span class="signature">migrate()</span>
|
||||
|
||||
<a href="https://github.com/poanetwork/poa-netstats-wharehouse/blob/v0.1.0/lib/poa_backend/release/tasks.ex#L17" class="view-source" rel="help" title="View Source">
|
||||
<span class="icon-code" aria-hidden="true"></span>
|
||||
<span class="sr-only">View Source</span>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<section class="docstring">
|
||||
|
||||
</section>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<footer class="footer">
|
||||
<p>
|
||||
<span class="line">
|
||||
Built using
|
||||
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.18.4),
|
||||
</span>
|
||||
<span class="line">
|
||||
designed by
|
||||
<a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
|
||||
</span>
|
||||
</p>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script src="dist/app-9bd040e5e5.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
|
@ -8,7 +8,7 @@
|
|||
<title>POABackend – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
@ -176,18 +176,35 @@ mix dialyzer</code></pre>
|
|||
|
||||
<p>To build an executable you’ll need Elixir 1.6 (and Erlang/OTP 20).</p>
|
||||
<ol>
|
||||
<li>Start a clean Terminal
|
||||
</li>
|
||||
<li>Once you have a copy of this repository configure the backend for production in the file <code class="inline">config/prod.exs</code>.
|
||||
</li>
|
||||
<li>An example configuration can be found in the current <code class="inline">config/prod.exs</code>.
|
||||
</li>
|
||||
<li>Do a <code class="inline">mix deps.get</code> to fetch, among other dependencies, the tooling for building server executables.
|
||||
</li>
|
||||
<li>We have to export the <code class="inline">MNESIA_HOST</code> variable in order to tell in which node we are going to create the mnesia schema
|
||||
</li>
|
||||
</ol>
|
||||
<pre><code class="elixir">export MNESIA_HOST=poa_backend@127.0.0.1</code></pre>
|
||||
<ol start="5">
|
||||
<li>A <code class="inline">env MIX_ENV=prod mix release --name=poa_backend --env=prod</code> will assemble an executable.
|
||||
</li>
|
||||
</ol>
|
||||
<p>A resulting artifact resides at <code class="inline">_build/prod/rel/poa_backend/releases/0.1.0/poa_backend.tar.gz</code> which you can move to a remote host.
|
||||
Use <code class="inline">tar xfz</code> then <code class="inline">bin/poa_agent start</code> (<code class="inline">bin/poa_agent stop</code> will stop the server cleanly).</p>
|
||||
Use <code class="inline">tar xfz</code> then <code class="inline">bin/poa_backend start</code> (<code class="inline">bin/poa_backend stop</code> will stop the server cleanly).</p>
|
||||
<p>If you want to run it on the local host then the procedure is as simple as: <code class="inline">_build/prod/rel/poa_backend/bin/poa_backend</code>.</p>
|
||||
<ol start="6">
|
||||
<li>Set up Mnesia. After start the <a href="POABackend.html#content"><code class="inline">POABackend</code></a> we have to set up mnesia. First we have to check if the Mnesia directory exists (probably not). In our case we have set it to <code class="inline">priv/data/mnesia</code>
|
||||
</li>
|
||||
</ol>
|
||||
<pre><code class="elixir">config :mnesia,
|
||||
dir: 'priv/data/mnesia' # make sure this directory exists!</code></pre>
|
||||
<p>so we have to create that folder inside the release folder.</p>
|
||||
<p>After that we have to create and migrate the database. In order to do that we have make a <code class="inline">RPC</code> to the running node, this command is run only once (<em>Note that the node must be running, that means we have executed <code class="inline">bin/poa_backend start</code></em>):</p>
|
||||
<pre><code class="elixir">bin/poa_backend rpc Elixir.POABackend.Release.Tasks migrate</code></pre>
|
||||
<p>That will create the Mnesia Database. After those steps the app is ready to be used</p>
|
||||
<p><strong>Note:</strong> executables must be built on the platform (OS and architecture) they are destined for under the project’s current configuration.
|
||||
Other options are possible (see <code class="inline">https://hexdocs.pm/distillery/getting-started.html</code>).</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>API Reference – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
@ -215,6 +215,14 @@ database. If we want to use it we have to declare it in the Config file, inside
|
|||
database. If we want to use it we have to declare it in the Config file, inside the <code class="inline">:receivers</code> section, ie</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="summary-row">
|
||||
<div class="summary-signature"><a href="POABackend.Release.Tasks.html">POABackend.Release.Tasks</a></div>
|
||||
|
||||
<div class="summary-synopsis"><p>This module is needed when we create a release. We are using Mnesia locally so when we start create a release
|
||||
we have to create the Mnesia files there. In order to do that we have to run this <a href="#migrate/0"><code class="inline">migrate/0</code></a> function</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -8,7 +8,7 @@
|
|||
<title>Initial Architecture – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<title>Search – poa_backend v0.1.0</title>
|
||||
<link rel="stylesheet" href="dist/app-480ffdc169.css" />
|
||||
|
||||
<script src="dist/sidebar_items-f62ce50de1.js"></script>
|
||||
<script src="dist/sidebar_items-3a7a458c10.js"></script>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue