mirror of https://github.com/zonemaster/zonemaster-gui.git synced 2025-11-22 16:31:04 +01:00

The Zonemaster GUI - part of the Zonemaster project

Find a file

Mats Dufberg 46419674e9 Merge pull request #500 from sewebb/ssg-standalone-components Static Zonemaster GUI with Astro & Svelte		2025-11-19 13:22:34 +01:00
.github	Update snapshots and playwright version	2024-06-13 11:53:22 +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
docs	Add migration guide and update installation documentation	2025-10-02 07:54:43 +02:00
e2e	Updated tests and test env	2025-05-26 13:19:38 +02:00
messages	add missing translations	2025-11-05 10:53:58 +01:00
project.inlang	add Slovenian language config	2025-08-27 08:41:48 +02:00
scripts	change name of zip-file generated	2025-05-13 08:18:31 +02:00
src	rename language tags	2025-11-05 13:48:28 +01:00
static	add message banner and docmentation	2025-06-05 08:43:48 +02:00
.browserslistrc	upgrade dependencies	2021-08-19 15:05:42 +02:00
.editorconfig	Prettier	2025-03-13 09:53:53 +01:00
.env.example	Added support for configurable pollingInterval	2025-04-30 09:13:54 +02: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	Updated tests and test env	2025-05-26 13:19:38 +02:00
Changes	Merge remote-tracking branch 'upstream/feature/ssg-standalone-components' into ssg-standalone-components	2025-11-19 10:21:41 +01:00
config.ts	add Slovenian language config	2025-08-27 08:41:48 +02:00
CONTRIBUTE.md	Added contribution guidelines	2025-05-12 13:32:55 +02:00
LICENSE	Updates license statements	2021-06-09 20:08:40 +02:00
package-lock.json	Added svelte plugin for prettier	2025-09-22 16:45:03 +02:00
package.json	Updated deps	2025-09-22 12:31:01 +02:00
playwright.config.ts	Updated tests and test env	2025-05-26 13:19:38 +02:00
README.md	Updated readme and added config documentation	2025-06-15 21:42:58 +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	Added untested webserver confs example	2025-04-30 00:20:56 +02:00
zonemaster.conf-example	Added missing parts in the example apache conf	2025-10-15 14:21:24 +02:00

README.md

Zonemaster Web GUI

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:

Clone the repository
Run npm install
Run cp .env.example .env
Set the URL to your Zonemaster backend in the .env file
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.

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.