hannaeko/zonemaster-gui
1
0
Fork 0
mirror of https://github.com/zonemaster/zonemaster-gui.git synced 2026-06-18 17:02:19 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
The Zonemaster GUI - part of the Zonemaster project
1,569 commits 2 branches 27 tags 26 MiB
  • TypeScript 46.3%
  • Svelte 23.7%
  • CSS 18.5%
  • Astro 7%
  • JavaScript 3.8%
  • Other 0.6%
Find a file
Exact
tgreenx b604cb2865
Some checks failed
CI / Run end-to-end tests (push) Has been cancelled
Details
CI / build-artifact (push) Has been cancelled
Details
Merge pull request #549 from tgreenx/audit-fix 
Update GUI dependencies
2026-06-17 14:30:20 +02:00
.github CI: force update 2026-06-16 09:38:59 +02:00
.vscode Build improvements 2025-04-14 08:00:14 +02:00
demo Added support for configurable pollingInterval 2025-04-30 09:13:54 +02:00
docker minimise intermediate layer 2026-05-20 10:09:29 +02:00
docs Update unit testing documentation 2026-02-19 17:33:43 +01:00
e2e Handle empty testcase strings in results 2026-05-20 10:48:42 +02:00
messages Merge pull request #507 from tgreenx/new-gui-translation-da 2025-12-16 10:48:58 +01:00
scripts Refactor message generation and validation logic 2025-12-15 21:49:27 +01:00
src Handle empty testcase strings in results 2026-05-20 10:48:42 +02:00
static add message banner and docmentation 2025-06-05 08:43:48 +02:00
.browserslistrc Update master to state of develop 2021-12-06 00:33:02 +01:00
.editorconfig Prettier 2025-03-13 09:53:53 +01:00
.env.example Allow serving the GUI from a subdirectory 2025-12-15 08:35:37 +01:00
.gitignore add vendor to gitignore 2025-10-29 14:07:27 +01:00
.prettierignore Prettier setup 2025-02-10 07:30:41 +01:00
.prettierrc Added svelte plugin for prettier 2025-09-22 16:45:03 +02:00
astro.config.mjs Custom i18n solution to replace paraglide 2025-12-15 21:49:25 +01:00
Changes Editorial update 2026-03-04 14:45:14 +01:00
config.ts Allow serving the GUI from a subdirectory 2025-12-15 08:35:37 +01:00
CONTRIBUTE.md Added contribution guidelines 2025-05-12 13:32:55 +02:00
LICENSE Update master to state of develop 2021-12-06 00:33:02 +01:00
Makefile Change docker image name from 'gui' to 'all-in-one' 2026-05-28 08:43:09 +02:00
package-lock.json Run npm audit fix (non-breaking changes) 2026-06-17 11:48:00 +02:00
package.json Updates playwright version 2026-06-15 08:59:48 +00:00
playwright.config.ts Updates for e2e tests 2025-11-24 21:15:46 +00:00
README.md Update README.md 2026-06-16 09:37:51 +02:00
svelte.config.js Add input names and improve TypeScript types for event handling 2025-04-14 09:44:23 +02:00
tsconfig.json Read version from package.json 2025-06-04 12:01:36 +02:00
zonemaster-nginx.conf-example Fix typos in nginx example configuration 2025-12-03 14:59:18 +01:00
zonemaster.conf-example Add automatic browser redirect to default language 2026-02-10 13:23:07 +01:00

README.md

Zonemaster Web GUI CI status

Overview

Zonemaster GUI is the web interface component of the Zonemaster project, a tool designed for DNS validation and testing. For a comprehensive overview of the Zonemaster software, please see the Zonemaster repository.

Prerequisites

Before installing the Zonemaster GUI, ensure you have the Zonemaster Engine and Zonemaster-Backend setup. Refer to the Zonemaster-Engine installation and Zonemaster-Backend installation documents.

Installation

There are two ways to install the Zonemaster GUI:

Quick Install (1 minute)

Download the release zip file, upload to your web server, and configure.

Full Customization (5 minutes)

Clone the repository, build, and deploy.

For detailed instructions, see INSTALL.md.

Development

To set up your development environment:

  1. Clone the repository
  2. Run npm install
  3. Run cp .env.example .env
  4. Set the URL to your Zonemaster backend in the .env file
  5. Run npm run dev

Documentation

Refer to the docs directory for detailed information on:

  • Installation and configuration
  • Theming and customization
  • Translation guide
  • Testing
  • UI documentation

For contribution guidelines, see CONTRIBUTE.md.

CI artifact

A zip (zonemaster_web_gui_<version>.zip) is built and uploaded as a GitHub Actions artifact on every push and pull request. This artifact can be useful for release testing and PR review. To download it:

  1. Go to the Actions tab of the repository.
  2. Select a workflow run (e.g. for a specific PR or branch).
  3. Scroll to the bottom of the run summary to the Artifacts section.
  4. Download the artifact named zonemaster_web_gui_<version>-<short_sha>. The artifact name includes the module version and the first 7 characters of the commit SHA.

License

This is free software under a 2-clause BSD license. The full text of the license can be found in the LICENSE file included in this repository.

Images src/assets/images/person_looking_at_computer.svg and src/assets/images/world_connected.svg are taken from https://undraw.co, full license.

Images src/assets/images/person_looking_at_computer.svg and src/assets/images/world_connected.svg are taken from https://undraw.co, full license.