This commit is contained in:
github-actions[bot] 2024-12-10 17:35:43 +00:00
parent 5d5589bfb5
commit 199ee1ec43
27 changed files with 45 additions and 28 deletions

View file

@ -12,7 +12,7 @@
<link rel="icon" href="/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -14,7 +14,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
@ -1139,11 +1139,28 @@
<p><a href="https://github.com/mailhog/MailHog">mailhog</a> is an excellent standalone mock SMTP server (with a UI) for testing and dev.</p>
</blockquote>
<h3 id="running-the-dev-environment">Running the dev environment<a class="headerlink" href="#running-the-dev-environment" title="Permanent link">&para;</a></h3>
<p>You can run your dev environment locally or inside containers.</p>
<p>After setting up the dev environment, you can visit <code>http://localhost:8080</code>.</p>
<ol>
<li>Locally</li>
<li>Run <code>make run</code> to start the listmonk dev server on <code>:9000</code>.</li>
<li>Run <code>make run-frontend</code> to start the Vue frontend in dev mode using yarn on <code>:8080</code>. All <code>/api/*</code> calls are proxied to the app running on <code>:9000</code>. Refer to the <a href="https://github.com/knadh/listmonk/blob/master/frontend/README.md">frontend README</a> for an overview on how the frontend is structured.</li>
<li>Visit <code>http://localhost:8080</code></li>
<li>
<p>Run <code>make run-frontend</code> to start the Vue frontend in dev mode using yarn on <code>:8080</code>. All <code>/api/*</code> calls are proxied to the app running on <code>:9000</code>. Refer to the <a href="https://github.com/knadh/listmonk/blob/master/frontend/README.md">frontend README</a> for an overview on how the frontend is structured.</p>
</li>
<li>
<p>Inside containers (Using Makefile)</p>
</li>
<li>Run <code>make init-dev-docker</code> to setup container for db.</li>
<li>Run <code>make dev-docker</code> to setup docker container suite.</li>
<li>
<p>Run <code>make rm-dev-docker</code> to clean up docker container suite.</p>
</li>
<li>
<p>Inside containers (Using devcontainer)</p>
</li>
<li>Open repo in vscode, open command palette, and select "Dev Containers: Rebuild and Reopen in Container".</li>
</ol>
<p>It will set up db, and start frontend/backend for you.</p>
<h1 id="production-build">Production build<a class="headerlink" href="#production-build" title="Permanent link">&para;</a></h1>
<p>Run <code>make dist</code> to build the Go binary, build the Javascript frontend, and embed the static assets producing a single self-contained binary, <code>listmonk</code></p>

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -14,7 +14,7 @@
<link rel="icon" href="images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

File diff suppressed because one or more lines are too long

Binary file not shown.

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">

View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">