Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

Reorganise admin static files and finalize icon build.

Kailash Nadh14a45e684bd9
diff --git a/.gitignore b/.gitignore
index 331a0b8b..e6c1800f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,6 +11,7 @@ email-builder/yarn.lock
email-builder/dist/
static/public/static/altcha.umd.js
static/admin/dist/
+scripts/.icons/
.vscode/
config.toml
diff --git a/Makefile b/Makefile
index 5fca1bda..d7aa6519 100644
--- a/Makefile
+++ b/Makefile
@@ -10,15 +10,20 @@ BUILDSTR := ${VERSION} (\#${LAST_COMMIT} $(BUILDDATE))
GOPATH ?= $(HOME)/go
STUFFBIN ?= $(GOPATH)/bin/stuffbin
-# SSR admin frontend (built from static/admin/src -> static/admin/dist).
+# SSR admin frontend (built from static/admin/assets -> static/admin/dist).
FRONTEND = static/admin
FRONTEND_DIST = $(FRONTEND)/dist
FRONTEND_NODE_MODULES = $(FRONTEND)/node_modules
+
+# Feather icons SVG sprite generated from icons.txt.
+FRONTEND_ICONS_LIST = $(FRONTEND)/icons.txt
+FRONTEND_ICONS = $(FRONTEND)/assets/static/icons.svg
+
FRONTEND_DEPS = \
$(FRONTEND_NODE_MODULES) \
$(FRONTEND)/package.json \
$(FRONTEND)/build.mjs \
- $(shell find $(FRONTEND)/src -type f)
+ $(shell find $(FRONTEND)/assets -type f)
BIN := listmonk
STATIC := config.toml.sample \
@@ -54,8 +59,15 @@ $(FRONTEND_NODE_MODULES): $(FRONTEND)/package.json
cd $(FRONTEND) && bun install
touch -c $(FRONTEND_NODE_MODULES)
+# Generate svg icon sprite.
+$(FRONTEND_ICONS): $(FRONTEND_ICONS_LIST) scripts/build-icons.py
+ python3 scripts/build-icons.py --icons $(FRONTEND_ICONS_LIST) --out $(FRONTEND_ICONS)
+
+.PHONY: build-icons
+build-icons: $(FRONTEND_ICONS)
+
# Build the SSR admin frontend (Bun) into static/admin/dist.
-$(FRONTEND_DIST): $(FRONTEND_DEPS)
+$(FRONTEND_DIST): $(FRONTEND_ICONS) $(FRONTEND_DEPS)
cd $(FRONTEND) && bun run build
touch -c $(FRONTEND_DIST)
diff --git a/frontend-vue/feathericons/build.py b/frontend-vue/feathericons/build.py
deleted file mode 100644
index d95ea66e..00000000
--- a/frontend-vue/feathericons/build.py
+++ /dev/null
@@ -1,119 +0,0 @@
-#!/usr/bin/env python3
-
-import argparse
-import shutil
-import xml.etree.ElementTree as ET
-from pathlib import Path
-from urllib.request import urlretrieve
-from zipfile import ZipFile
-
-FEATHER_ZIP_URL = "https://github.com/feathericons/feather/archive/refs/heads/master.zip"
-
-
-def setup_files(vendor_dir: Path) -> Path:
- feather_dir = vendor_dir / "feather"
- icons_dir = feather_dir / "icons"
- if icons_dir.exists():
- return feather_dir
-
- vendor_dir.mkdir(parents=True, exist_ok=True)
-
- zip_path = vendor_dir / "feather.zip"
- extract_dir = vendor_dir / "_feather_extract"
-
- if extract_dir.exists():
- shutil.rmtree(extract_dir)
-
- print("Downloading Feather icons...")
- urlretrieve(FEATHER_ZIP_URL, zip_path)
-
- print("Extracting Feather icons...")
- with ZipFile(zip_path) as z:
- z.extractall(extract_dir)
-
- extracted_root = next(extract_dir.iterdir())
-
- if feather_dir.exists():
- shutil.rmtree(feather_dir)
-
- shutil.move(str(extracted_root), str(feather_dir))
-
- zip_path.unlink()
- shutil.rmtree(extract_dir)
-
- return feather_dir
-
-
-def read_icons(path: Path) -> list[str]:
- return [
- line.strip()
- for line in path.read_text(encoding="utf-8").splitlines()
- if line.strip()
- ]
-
-
-def svg_to_symbol(feather_dir: Path, icon_name: str) -> str:
- path = feather_dir / "icons" / f"{icon_name}.svg"
-
- if not path.exists():
- raise FileNotFoundError(f"Missing Feather icon: {icon_name}")
-
- root = ET.parse(path).getroot()
- for elem in root.iter():
- elem.tag = elem.tag.rsplit("}", 1)[-1]
-
- viewbox = root.attrib.get("viewBox", "0 0 24 24")
-
- attrs = {
- "id": f"icon-{icon_name}",
- "viewBox": viewbox,
- "fill": root.attrib.get("fill", "none"),
- "stroke": root.attrib.get("stroke", "currentColor"),
- "stroke-width": root.attrib.get("stroke-width", "2"),
- "stroke-linecap": root.attrib.get("stroke-linecap", "round"),
- "stroke-linejoin": root.attrib.get("stroke-linejoin", "round"),
- }
-
- attr_str = " ".join(f'{k}="{v}"' for k, v in attrs.items())
- children = "".join(ET.tostring(child, encoding="unicode")
- for child in root)
-
- return f" <symbol {attr_str}>\n {children}\n </symbol>"
-
-
-def build_sprite(vendor_dir: Path, icons_path: Path, out_path: Path) -> None:
- feather_dir = setup_files(vendor_dir)
- icons = read_icons(icons_path)
-
- out_path.parent.mkdir(parents=True, exist_ok=True)
- symbols = "\n\n".join(svg_to_symbol(feather_dir, name) for name in icons)
-
- sprite = f'''<svg xmlns="http://www.w3.org/2000/svg" style="display:none">
-{symbols}
-</svg>
-'''
-
- out_path.write_text(sprite, encoding="utf-8")
-
- print(f"Wrote {out_path}")
-
-
-def parse_args() -> argparse.Namespace:
- base_dir = Path(__file__).resolve().parent
- parser = argparse.ArgumentParser(
- description="Build a Feather icons SVG sprite.")
- parser.add_argument(
- "--dir", type=Path, default=base_dir / ".icons", help="vendor directory"
- )
- parser.add_argument(
- "--icons", type=Path, default=base_dir / "icons.txt", help="icon list"
- )
- parser.add_argument(
- "--out", type=Path, default=base_dir / "icons.svg", help="sprite output file"
- )
- return parser.parse_args()
-
-
-if __name__ == "__main__":
- args = parse_args()
- build_sprite(args.dir, args.icons, args.out)
diff --git a/static/admin/src/css/style.css b/static/admin/assets/css/style.css
similarity index 100%
rename from static/admin/src/css/style.css
rename to static/admin/assets/css/style.css
diff --git a/static/admin/src/js/code-editor.js b/static/admin/assets/js/code-editor.js
similarity index 100%
rename from static/admin/src/js/code-editor.js
rename to static/admin/assets/js/code-editor.js
diff --git a/static/admin/src/js/content.js b/static/admin/assets/js/content.js
similarity index 100%
rename from static/admin/src/js/content.js
rename to static/admin/assets/js/content.js
diff --git a/static/admin/src/js/editor-theme.js b/static/admin/assets/js/editor-theme.js
similarity index 100%
rename from static/admin/src/js/editor-theme.js
rename to static/admin/assets/js/editor-theme.js
diff --git a/static/admin/src/js/i18n.js b/static/admin/assets/js/i18n.js
similarity index 100%
rename from static/admin/src/js/i18n.js
rename to static/admin/assets/js/i18n.js
diff --git a/static/admin/src/js/main.js b/static/admin/assets/js/main.js
similarity index 100%
rename from static/admin/src/js/main.js
rename to static/admin/assets/js/main.js
diff --git a/static/admin/src/js/richtext-editor.js b/static/admin/assets/js/richtext-editor.js
similarity index 100%
rename from static/admin/src/js/richtext-editor.js
rename to static/admin/assets/js/richtext-editor.js
diff --git a/static/admin/src/js/table.js b/static/admin/assets/js/table.js
similarity index 100%
rename from static/admin/src/js/table.js
rename to static/admin/assets/js/table.js
diff --git a/static/admin/src/js/utils.js b/static/admin/assets/js/utils.js
similarity index 100%
rename from static/admin/src/js/utils.js
rename to static/admin/assets/js/utils.js
diff --git a/static/admin/src/js/views/analytics.js b/static/admin/assets/js/views/analytics.js
similarity index 100%
rename from static/admin/src/js/views/analytics.js
rename to static/admin/assets/js/views/analytics.js
diff --git a/static/admin/src/js/views/bounces.js b/static/admin/assets/js/views/bounces.js
similarity index 100%
rename from static/admin/src/js/views/bounces.js
rename to static/admin/assets/js/views/bounces.js
diff --git a/static/admin/src/js/views/campaign.js b/static/admin/assets/js/views/campaign.js
similarity index 100%
rename from static/admin/src/js/views/campaign.js
rename to static/admin/assets/js/views/campaign.js
diff --git a/static/admin/src/js/views/campaigns.js b/static/admin/assets/js/views/campaigns.js
similarity index 100%
rename from static/admin/src/js/views/campaigns.js
rename to static/admin/assets/js/views/campaigns.js
diff --git a/static/admin/src/js/views/dashboard.js b/static/admin/assets/js/views/dashboard.js
similarity index 100%
rename from static/admin/src/js/views/dashboard.js
rename to static/admin/assets/js/views/dashboard.js
diff --git a/static/admin/src/js/views/forms.js b/static/admin/assets/js/views/forms.js
similarity index 100%
rename from static/admin/src/js/views/forms.js
rename to static/admin/assets/js/views/forms.js
diff --git a/static/admin/src/js/views/import.js b/static/admin/assets/js/views/import.js
similarity index 100%
rename from static/admin/src/js/views/import.js
rename to static/admin/assets/js/views/import.js
diff --git a/static/admin/src/js/views/lists.js b/static/admin/assets/js/views/lists.js
similarity index 100%
rename from static/admin/src/js/views/lists.js
rename to static/admin/assets/js/views/lists.js
diff --git a/static/admin/src/js/views/logs.js b/static/admin/assets/js/views/logs.js
similarity index 100%
rename from static/admin/src/js/views/logs.js
rename to static/admin/assets/js/views/logs.js
diff --git a/static/admin/src/js/views/maintenance.js b/static/admin/assets/js/views/maintenance.js
similarity index 100%
rename from static/admin/src/js/views/maintenance.js
rename to static/admin/assets/js/views/maintenance.js
diff --git a/static/admin/src/js/views/media.js b/static/admin/assets/js/views/media.js
similarity index 100%
rename from static/admin/src/js/views/media.js
rename to static/admin/assets/js/views/media.js
diff --git a/static/admin/src/js/views/profile.js b/static/admin/assets/js/views/profile.js
similarity index 100%
rename from static/admin/src/js/views/profile.js
rename to static/admin/assets/js/views/profile.js
diff --git a/static/admin/src/js/views/roles.js b/static/admin/assets/js/views/roles.js
similarity index 100%
rename from static/admin/src/js/views/roles.js
rename to static/admin/assets/js/views/roles.js
diff --git a/static/admin/src/js/views/settings.js b/static/admin/assets/js/views/settings.js
similarity index 100%
rename from static/admin/src/js/views/settings.js
rename to static/admin/assets/js/views/settings.js
diff --git a/static/admin/src/js/views/subscribers.js b/static/admin/assets/js/views/subscribers.js
similarity index 100%
rename from static/admin/src/js/views/subscribers.js
rename to static/admin/assets/js/views/subscribers.js
diff --git a/static/admin/src/js/views/templates.js b/static/admin/assets/js/views/templates.js
similarity index 100%
rename from static/admin/src/js/views/templates.js
rename to static/admin/assets/js/views/templates.js
diff --git a/static/admin/src/js/views/users.js b/static/admin/assets/js/views/users.js
similarity index 100%
rename from static/admin/src/js/views/users.js
rename to static/admin/assets/js/views/users.js
diff --git a/static/admin/src/js/visual-editor.js b/static/admin/assets/js/visual-editor.js
similarity index 100%
rename from static/admin/src/js/visual-editor.js
rename to static/admin/assets/js/visual-editor.js
diff --git a/static/admin/src/static/email-builder/email-builder.umd.js b/static/admin/assets/static/email-builder/email-builder.umd.js
similarity index 100%
rename from static/admin/src/static/email-builder/email-builder.umd.js
rename to static/admin/assets/static/email-builder/email-builder.umd.js
diff --git a/static/admin/src/static/favicon.png b/static/admin/assets/static/favicon.png
similarity index 100%
rename from static/admin/src/static/favicon.png
rename to static/admin/assets/static/favicon.png
diff --git a/static/admin/src/static/fonts/Inter-Bold.woff2 b/static/admin/assets/static/fonts/Inter-Bold.woff2
similarity index 100%
rename from static/admin/src/static/fonts/Inter-Bold.woff2
rename to static/admin/assets/static/fonts/Inter-Bold.woff2
diff --git a/static/admin/src/static/fonts/Inter-Medium.woff2 b/static/admin/assets/static/fonts/Inter-Medium.woff2
similarity index 100%
rename from static/admin/src/static/fonts/Inter-Medium.woff2
rename to static/admin/assets/static/fonts/Inter-Medium.woff2
diff --git a/static/admin/src/static/fonts/Inter-Regular.woff2 b/static/admin/assets/static/fonts/Inter-Regular.woff2
similarity index 100%
rename from static/admin/src/static/fonts/Inter-Regular.woff2
rename to static/admin/assets/static/fonts/Inter-Regular.woff2
diff --git a/static/admin/src/static/fonts/Inter-SemiBold.woff2 b/static/admin/assets/static/fonts/Inter-SemiBold.woff2
similarity index 100%
rename from static/admin/src/static/fonts/Inter-SemiBold.woff2
rename to static/admin/assets/static/fonts/Inter-SemiBold.woff2
diff --git a/static/admin/src/static/icons.svg b/static/admin/assets/static/icons.svg
similarity index 100%
rename from static/admin/src/static/icons.svg
rename to static/admin/assets/static/icons.svg
diff --git a/static/admin/src/static/logo.png b/static/admin/assets/static/logo.png
similarity index 100%
rename from static/admin/src/static/logo.png
rename to static/admin/assets/static/logo.png
diff --git a/static/admin/src/static/logo.svg b/static/admin/assets/static/logo.svg
similarity index 100%
rename from static/admin/src/static/logo.svg
rename to static/admin/assets/static/logo.svg
diff --git a/static/admin/build.mjs b/static/admin/build.mjs
index 417306cb..24dfb792 100644
--- a/static/admin/build.mjs
+++ b/static/admin/build.mjs
@@ -8,7 +8,7 @@ import path from 'node:path';
import { fileURLToPath } from 'node:url';
const root = path.dirname(fileURLToPath(import.meta.url));
-const srcJS = path.join(root, 'src/js');
+const srcJS = path.join(root, 'assets/js');
const dist = path.join(root, 'dist');
const watch = process.argv.includes('--watch');
@@ -22,7 +22,7 @@ const vendor = [
];
// TinyMCE has a lot of files to copy.
-// TINY_PLUGINS and TINY_LANGS MUST mirror src/js/richtext-editor.js.
+// TINY_PLUGINS and TINY_LANGS MUST mirror assets/js/richtext-editor.js.
const TINY_PLUGINS = [
'anchor', 'autoresize', 'autolink', 'charmap', 'emoticons', 'fullscreen',
'help', 'hr', 'image', 'imagetools', 'link', 'lists', 'paste', 'searchreplace',
@@ -65,15 +65,15 @@ async function build() {
await mkdir(dist, { recursive: true });
// Verbatim static assets (fonts, icons, images), authored stylesheet, vendored libs.
- await cp(path.join(root, 'src/static'), dist, { recursive: true });
- await cp(path.join(root, 'src/css/style.css'), path.join(dist, 'style.css'));
+ await cp(path.join(root, 'assets/static'), dist, { recursive: true });
+ await cp(path.join(root, 'assets/css/style.css'), path.join(dist, 'style.css'));
for (const [from, to] of vendor) {
await cp(path.join(root, from), path.join(dist, to));
}
await copyTinyMCE();
// Entry points = modules loaded directly by a <script> tag: the global main.js and
- // every per-view module under src/js/views/.
+ // every per-view module under assets/js/views/.
const views = (await readdir(path.join(srcJS, 'views')))
.filter((f) => f.endsWith('.js'))
.map((f) => path.join(srcJS, 'views', f));
@@ -105,9 +105,9 @@ async function build() {
await build();
if (watch) {
- console.log('watching src/ for changes…');
+ console.log('watching assets/ for changes…');
let timer = null;
- fsWatch(path.join(root, 'src'), { recursive: true }, () => {
+ fsWatch(path.join(root, 'assets'), { recursive: true }, () => {
clearTimeout(timer);
timer = setTimeout(() => build().catch((e) => console.error(e)), 100);
});
diff --git a/frontend-vue/feathericons/icons.txt b/static/admin/icons.txt
similarity index 100%
rename from frontend-vue/feathericons/icons.txt
rename to static/admin/icons.txt