Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
350 commits
Select commit Hold shift + click to select a range
22fc226
Cleanup
tbleckert Apr 15, 2025
1fb20b4
Migrate component styles to separate CSS files for easier theming and…
tbleckert Apr 16, 2025
bf9687a
added and modified some variables for theming
rhedman Apr 16, 2025
fe9bd48
rename variable
rhedman Apr 16, 2025
9e1ef7d
minor margin fix
rhedman Apr 22, 2025
54c6d9e
add Notice above Options
rhedman Apr 23, 2025
e9a0eca
no max-width here
rhedman Apr 23, 2025
3c6eda3
add URL to link
rhedman Apr 23, 2025
018a175
underline body text links
rhedman Apr 23, 2025
e2e8c1d
bold links
rhedman Apr 23, 2025
02d39f4
Move global js to the theme
tbleckert Apr 23, 2025
aa84c68
Make sure pages are prerendered
tbleckert Apr 23, 2025
0aff4e6
Build fixes
tbleckert Apr 23, 2025
bad4580
Force rerender on result id diff
tbleckert Apr 23, 2025
43e4a6d
Support setting api endpoint via window
tbleckert Apr 23, 2025
dc14f22
Allow multiple instances of the TestAgent
tbleckert Apr 23, 2025
1245989
Refactor – move out reset and redirect logic from agent to component
tbleckert Apr 23, 2025
6af3482
added tons of translations
rhedman Apr 24, 2025
e456d90
Do a real redirect after completed test
tbleckert Apr 24, 2025
8bf31a3
add Article component
rhedman Apr 24, 2025
69139c3
finished Article component
rhedman Apr 24, 2025
03318ec
remove unused import
rhedman Apr 24, 2025
fe468fc
add image alt text translations
rhedman Apr 24, 2025
3f6dfef
change path to astro import
rhedman Apr 24, 2025
b7d4741
add all FAQ questions and translate to swedish
rhedman Apr 25, 2025
69fa05c
add lang to faq link URL
rhedman Apr 25, 2025
5dca103
make logo smaller on mobile
rhedman Apr 25, 2025
75d6b81
Fully static build
tbleckert Apr 29, 2025
5e8da7b
Added release zipping
tbleckert Apr 29, 2025
07c5f13
Added untested webserver confs example
tbleckert Apr 29, 2025
ff6b565
Cleanup
tbleckert Apr 29, 2025
479213b
Move docs files
tbleckert Apr 29, 2025
a293fef
Added support for configurable pollingInterval
tbleckert Apr 30, 2025
8325225
Centralized config
tbleckert Apr 30, 2025
84d4720
Added email config
tbleckert Apr 30, 2025
af6f121
Simplified paths
tbleckert Apr 30, 2025
3f45bf6
Simplified config
tbleckert Apr 30, 2025
4c40200
remove underline in main menu links
rhedman Apr 30, 2025
730fe29
add siteName to config and header.astro
rhedman Apr 30, 2025
a8fb6e5
Added note about old doc
tbleckert May 12, 2025
3a8cca5
Added install documentation
tbleckert May 12, 2025
fec11dc
Added contribution guidelines
tbleckert May 12, 2025
33bdca4
Path fix
tbleckert May 12, 2025
6d0ee5b
Whitespace
tbleckert May 12, 2025
31e72b2
Include version name in release zip
tbleckert May 12, 2025
1bb2e38
Prepare e2e testing
tbleckert May 12, 2025
ec58bae
change name of zip-file generated
rhedman May 13, 2025
24fde0c
Reformat
tbleckert May 13, 2025
f756d9e
Fix playwright config
tbleckert May 13, 2025
6f78a20
Added types
tbleckert May 13, 2025
87a13da
Fix a test case
tbleckert May 13, 2025
5749e52
updates to docs
rhedman May 13, 2025
85df2ad
minor improvements
rhedman May 13, 2025
a04eb06
More test fixes
tbleckert May 13, 2025
364c3a5
More test fixes
tbleckert May 13, 2025
7cda638
Fix playwright config
tbleckert May 19, 2025
71e627a
Nameserver should be required if ip is filled
tbleckert May 19, 2025
1edd0a1
Migrated some tests and some copy changes
tbleckert May 19, 2025
05be40e
More test migration
tbleckert May 19, 2025
c43ffa6
Updated options and migrated more tests
tbleckert May 19, 2025
7339a88
Updated screenshots
tbleckert May 19, 2025
5c91f42
Fix test 21 and related fixes
tbleckert May 26, 2025
80a28bd
Cleanup and type fixes
tbleckert May 26, 2025
4a8191b
Updated tests and test env
tbleckert May 26, 2025
e331c11
add som variables for buttons and some minor style fixes
rhedman Jun 3, 2025
5cd0151
better alignment fix
rhedman Jun 3, 2025
98dc5b4
more alignment improvements
rhedman Jun 3, 2025
067fd54
Support msg banner
tbleckert Jun 4, 2025
807a30b
Read version from package.json
tbleckert Jun 4, 2025
8657ac4
add message banner and docmentation
rhedman Jun 5, 2025
33a0654
move Article component till StartTest
rhedman Jun 9, 2025
65ce5d2
Updated readme and added config documentation
tbleckert Jun 15, 2025
9c2213e
CSS fixes
rhedman Jun 17, 2025
c35ba37
Remove Article from lang page as well
tbleckert Jun 18, 2025
009c551
Cleanup
tbleckert Jun 18, 2025
12ef68b
Always use language info from config, not source lang info.
tbleckert Jun 18, 2025
12e729a
Fixes related to export and share
tbleckert Jun 18, 2025
2ba890f
accessibility fixes regarding navigation
rhedman Jun 19, 2025
b4dd102
add label for domain name input
rhedman Jun 19, 2025
b729073
change delete buttons to danger variant
rhedman Jun 19, 2025
ed655a0
Accessibility improvements
tbleckert Jun 19, 2025
cf1ad57
Accessibility improvements
tbleckert Jun 19, 2025
7a83de1
Updated result badges with icons and minor design fixes
tbleckert Jun 19, 2025
d2202a2
wrap on smaller screens
rhedman Jun 19, 2025
67b080f
adjust font sizes for nameservers and DS records
rhedman Jun 23, 2025
a5a2a63
add focus styles to filter buttons
rhedman Jun 23, 2025
7b6d10e
Fix whitespace
tbleckert Jun 25, 2025
e6b62b2
Added testcase when result groups are open
tbleckert Jun 25, 2025
097812d
add border variant to default badge
rhedman Jun 25, 2025
ba031dd
Added icons to filter toggles
tbleckert Jun 25, 2025
b871b51
Added icons to result entries
tbleckert Jun 25, 2025
f7d390e
Correct type
tbleckert Jun 25, 2025
69917f4
Minor design fixes
tbleckert Jun 25, 2025
0119426
adjust colors, font-size and remove icon
rhedman Jun 25, 2025
fa6858f
Bugfix
tbleckert Jun 25, 2025
dbc3bec
change SASS-syntax to CSS
rhedman Jun 25, 2025
4dfbb7f
History dialog improvements
tbleckert Jun 25, 2025
6d407bb
add more colors to dialog levels
rhedman Jun 25, 2025
098743d
border color tweaking in dialog
rhedman Jun 25, 2025
ba2c8aa
Added history dialog tabs
tbleckert Jun 25, 2025
f4f63d7
history dialog style improvements
rhedman Jun 25, 2025
902fc43
fine tune width and space around dialog
rhedman Jun 26, 2025
5316b6f
try text-shadow to increase contrast for APCA minimums
rhedman Jun 26, 2025
6a09a70
also add text-shadow to badges
rhedman Jun 26, 2025
767ffde
add missing Swedish translations
rhedman Jun 30, 2025
63e5c39
Correct titles on pages
tbleckert Jun 30, 2025
cf4ffb3
add base Slovenian translation file
rhedman Aug 27, 2025
b84f590
add Slovenian language config
rhedman Aug 27, 2025
61d1140
add more translations
rhedman Aug 28, 2025
d1b3127
minor copy change
rhedman Sep 2, 2025
5667428
add bottom margin to legend
rhedman Sep 2, 2025
483f86b
Set correct language in rpc calls
tbleckert Sep 10, 2025
155752b
make toggle buttons larger for accessibility
rhedman Sep 18, 2025
11eadaa
fix fieldset margins
rhedman Sep 22, 2025
c63c92b
Cleanup broken storybook setup
tbleckert Sep 11, 2025
45109ec
Minor code quality fixes
tbleckert Sep 11, 2025
fbde3bd
Whoops
tbleckert Sep 11, 2025
8ee930a
Updated astro
tbleckert Sep 11, 2025
faea087
Updated deps
tbleckert Sep 11, 2025
e10c77e
Format date in history dialog
tbleckert Sep 22, 2025
8e2831c
Handle backend errors
tbleckert Sep 22, 2025
6b1237c
add styles for input error
rhedman Sep 22, 2025
99a59bc
move class to root
rhedman Sep 22, 2025
e9eac06
Display backend errors
tbleckert Sep 22, 2025
2228fef
Fix button alignment
tbleckert Sep 22, 2025
d972cf8
Added svelte plugin for prettier
tbleckert Sep 22, 2025
e8f8ab5
Reformat
tbleckert Sep 22, 2025
7d41f47
adjust font size and paddings on errors
rhedman Sep 22, 2025
e91c7a1
fix global box-sizing
rhedman Sep 22, 2025
fdc1d2d
Correct count in badges
tbleckert Sep 22, 2025
79b2bd0
Refactor result data to solve counts, sorting and filtering
tbleckert Sep 24, 2025
1e62f27
move icon to the right of button for consistency
rhedman Sep 24, 2025
243cf5b
Added result group icons
tbleckert Sep 24, 2025
0ade192
Design fix
tbleckert Sep 24, 2025
1f557d9
add extra font size and aplly to test case icons
rhedman Sep 24, 2025
2efa56e
Add migration guide and update installation documentation
tbleckert Oct 2, 2025
ef5f31f
Added missing parts in the example apache conf
tbleckert Oct 15, 2025
f9364b5
add hover color variable for buttons
rhedman Oct 16, 2025
99856ea
Add static URL button and Profile Select
rhedman Oct 22, 2025
941ffb8
Improved error handling
tbleckert Oct 23, 2025
b72688b
Better return type
tbleckert Oct 23, 2025
78d8adb
Fill profile names select with real data
tbleckert Oct 23, 2025
4bc8668
Show profile select only when multiple profiles are available
tbleckert Oct 23, 2025
2f6b566
Refactor DomainTest form for improved IP type handling and readability
tbleckert Oct 23, 2025
bcb9230
add vendor to gitignore
rhedman Oct 29, 2025
d12309d
add hide utility class
rhedman Nov 5, 2025
d88cfab
add missing translations
rhedman Nov 5, 2025
f917b7c
hide TLD URL button in GUI for now
rhedman Nov 5, 2025
b8acf46
rename language tags
rhedman Nov 5, 2025
6b0d02a
Merge remote-tracking branch 'upstream/feature/ssg-standalone-compone…
tbleckert Nov 19, 2025
4641967
Merge pull request #500 from sewebb/ssg-standalone-components
matsduf Nov 19, 2025
8c2a537
Updates mpm version for CI
matsduf Nov 19, 2025
7426764
Updated tests
tbleckert Nov 24, 2025
fb602e9
Make sure all tests pass reliably
tbleckert Nov 24, 2025
3cdbb13
Prefix default language
tbleckert Nov 24, 2025
aa1d7c3
Keep language in url when redirecting to result
tbleckert Nov 24, 2025
39c43a0
Merge pull request #4 from sewebb/ssg-so-comp-update-ci
matsduf Nov 24, 2025
bc42113
Let the outside know we're mounted
tbleckert Nov 24, 2025
9286ce6
Wait for mount instead of network idle
tbleckert Nov 24, 2025
59bc92c
Default lang now has a prefix as well
tbleckert Nov 24, 2025
542c76e
Merge pull request #5 from sewebb/ssg-so-comp-update-ci
matsduf Nov 24, 2025
9eaf7ad
Update snapshot configuration and standardize snapshot file naming
tbleckert Nov 24, 2025
bbf0631
Merge pull request #6 from sewebb/ssg-so-comp-update-ci
matsduf Nov 24, 2025
f0dc549
Updates for e2e tests
matsduf Nov 24, 2025
81629b9
Merge pull request #512 from matsduf/ssg-so-comp-update-ci
matsduf Nov 24, 2025
b0d3980
Creates a directory above the served to match current configuration
matsduf Nov 19, 2025
69c6044
Sets version for v2025.2 release
matsduf Nov 19, 2025
645e073
Copies Apache configuration and license file to the zip file above th…
matsduf Nov 19, 2025
fec6609
Sets the same document root as used today
matsduf Nov 19, 2025
60d781d
Information moved or integrated by zonemaster/zonemaster#1442
matsduf Nov 25, 2025
5147773
File moved by zonemaster/zonemaster#1442
matsduf Nov 25, 2025
6ee8fb0
File to be integrated in document structure
matsduf Nov 25, 2025
b213358
Editorial updates
matsduf Nov 25, 2025
a74783e
Adds index (README) to the docs directory
matsduf Nov 26, 2025
0b2f6b2
Update English (source) FAQ
tgreenx Nov 13, 2025
6b5710e
Update Swedish FAQ
tgreenx Dec 2, 2025
756fe75
Remove heading in test-case-identifiers.md
tgreenx Dec 2, 2025
b38e078
Add French messages translation
tgreenx Nov 13, 2025
93f2994
Add French FAQ translation
tgreenx Nov 13, 2025
c5d2914
Update unit test for French
tgreenx Dec 2, 2025
c1f6e01
Merge pull request #513 from matsduf/adapt-to-installation
matsduf Dec 3, 2025
74678c2
Apply suggestions from document review
matsduf Dec 3, 2025
bc9e48a
Fix typos in nginx example configuration
marc-vanderwal Dec 3, 2025
4616311
Merge pull request #516 from marc-vanderwal/bugfix/nginx-configuration
matsduf Dec 3, 2025
2407651
Merge pull request #514 from matsduf/update-doc
matsduf Dec 3, 2025
6e3b13c
Merge pull request #502 from tgreenx/new-gui-translation-en
tgreenx Dec 4, 2025
48e76e2
Corrects link in message
matsduf Dec 5, 2025
1930a93
Corrects unit test
matsduf Dec 5, 2025
9c4ac6d
Updates Swedish translation of FAQ
matsduf Dec 5, 2025
bd846c0
Updates Swedish translation of messages
matsduf Dec 5, 2025
a014c5d
Updates e2e test to match updated translation
matsduf Dec 7, 2025
d45bfea
Updates e2e test to match updated translation
matsduf Dec 7, 2025
e5ed3d0
Updates e2e test to match updated translation
matsduf Dec 7, 2025
e6f445a
Adds missing keys
matsduf Dec 8, 2025
64d7a97
Merge pull request #517 from matsduf/update-en-messages
matsduf Dec 8, 2025
188797d
All languages should have a prefix
tbleckert Dec 8, 2025
965bf6f
Cleanup
tbleckert Dec 8, 2025
6407584
Merge pull request #519 from sewebb/fix-language-navigation-issues
matsduf Dec 8, 2025
bb02a39
Fix link path in French translation
tgreenx Dec 8, 2025
96785e0
Add Danish messages translation
tgreenx Nov 13, 2025
67ee4f6
Add Danish FAQ translation
tgreenx Nov 13, 2025
7b23506
Updates to Danish translation
tgreenx Dec 8, 2025
6fd414e
Add Spanish messages translation
tgreenx Nov 18, 2025
95b068d
Add Spanish FAQ translation
tgreenx Nov 18, 2025
5d297e7
Add Finnish messages translation
tgreenx Nov 18, 2025
0827388
Add Finnish FAQ translation
tgreenx Nov 18, 2025
2dc61d2
Updates to Finnish translation
tgreenx Dec 8, 2025
afb163e
Updates to Spanish translation
tgreenx Dec 8, 2025
7829f4e
Add Norwegian messages translation
tgreenx Nov 18, 2025
ba8daf9
Add Norwegian FAQ translation
tgreenx Nov 18, 2025
ce0bdc2
Updates to Norwegian translation
tgreenx Dec 8, 2025
ae98125
Add Slovenian messages translation
tgreenx Nov 18, 2025
c0924a0
Add Slovenian FAQ translation
tgreenx Nov 18, 2025
ec06a83
Updates to Slovenian translation
tgreenx Dec 8, 2025
b70db8f
Update e2e test for Slovenian
tgreenx Dec 8, 2025
a01d894
Update e2e test for Danish
tgreenx Dec 8, 2025
68b6336
Update e2e test for Spanish
tgreenx Dec 8, 2025
5cf6969
Update e2e test for Finnish
tgreenx Dec 8, 2025
87a8175
Update e2e test for Norwegian
tgreenx Dec 8, 2025
2c9968c
Apply suggestions from code review
tgreenx Dec 9, 2025
71fb779
Apply suggestions from code review
tgreenx Dec 9, 2025
6a83cb5
Apply suggestions from code review
tgreenx Dec 9, 2025
0c108ad
Apply suggestions from code review
tgreenx Dec 10, 2025
cf1de6a
Apply suggestions from code review
tgreenx Dec 10, 2025
d730c79
Update Norwegian translation after review by @repperille
tgreenx Dec 10, 2025
308e475
Update Norwegian translation after review by @repperille
tgreenx Dec 11, 2025
857d81c
Merge pull request #503 from tgreenx/new-gui-translation-fr
tgreenx Dec 11, 2025
f5b407e
Merge branch 'releases/ssg-standalone-components' into new-gui-transl…
tgreenx Dec 11, 2025
dc118ce
Merge pull request #504 from tgreenx/new-gui-translation-fi
tgreenx Dec 11, 2025
f855e74
Merge branch 'releases/ssg-standalone-components' into new-gui-transl…
tgreenx Dec 11, 2025
61d85f8
Merge pull request #505 from tgreenx/new-gui-translation-nb
tgreenx Dec 11, 2025
887f2c3
Merge branch 'releases/ssg-standalone-components' into new-gui-transl…
tgreenx Dec 11, 2025
1a1f739
Allow serving the GUI from a subdirectory
marc-vanderwal Dec 9, 2025
9cb9ebd
Merge pull request #518 from matsduf/update-sv-translation
matsduf Dec 15, 2025
f415d0a
Merge pull request #520 from marc-vanderwal/bugfix/gui-from-subdirectory
marc-vanderwal Dec 15, 2025
a783f5b
Merge pull request #508 from tgreenx/new-gui-translation-es
tgreenx Dec 15, 2025
65aff95
Use language prefix when navigating in history dialog
tbleckert Dec 12, 2025
311e1d9
Use a derived value for result so we always have the latest data
tbleckert Dec 12, 2025
ea91f01
Apply suggestions from code review
tgreenx Dec 15, 2025
c89ab9f
Update unit test for Slovenian
tgreenx Dec 15, 2025
f3dbf6d
Merge pull request #523 from sewebb/rerender-tests-correctly
matsduf Dec 15, 2025
23e8eec
Merge pull request #506 from tgreenx/new-gui-translation-sl
tgreenx Dec 15, 2025
d17203d
Custom i18n solution to replace paraglide
tbleckert Dec 8, 2025
627f266
Add isValidLocale utility and validate locale before setting
tbleckert Dec 8, 2025
da9ce5b
Refactor message generation and validation logic
tbleckert Dec 8, 2025
327a1e8
Upgraded Astro
tbleckert Dec 8, 2025
bac77d1
Updated patches
tbleckert Dec 8, 2025
bc332a8
Handle subdirectories when parsing language in middleware
tbleckert Dec 15, 2025
7594300
Merge pull request #521 from sewebb/replace-paraglide
matsduf Dec 16, 2025
ffc9eb3
Merge pull request #507 from tgreenx/new-gui-translation-da
tgreenx Dec 16, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ root = true
[*]
charset = utf-8
indent_style = space
indent_size = 2
indent_size = 4
insert_final_newline = true
trim_trailing_whitespace = true

Expand Down
3 changes: 3 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
PUBLIC_BASE_URL="/"
PUBLIC_API_URL="/api"
PUBLIC_POLLING_INTERVAL=5000
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:

- uses: actions/setup-node@v3
with:
node-version: 18.x
node-version: 24.x
cache: npm

- name: Install dependencies
Expand Down
63 changes: 28 additions & 35 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
# See http://help.github.com/ignore-files/ for more about ignoring files.

# compiled output
/dist
/dist-electron
/release-builds
/tmp
/out-tsc
# build output
dist/
public/


# Application onfiguration
/src/assets/app.config.json
# generated types
.astro/

# dependencies
/node_modules

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# environment variables
.env
.env.production

# IDEs and editors
/.idea
.project
Expand All @@ -22,44 +28,31 @@
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# misc
/.angular/cache
/.sass-cache
/connect.lock
/coverage
/libpeerconnection.log
npm-debug.log
testem.log
/typings

# e2e
/e2e/*.js
/e2e/*.map
.tmp

# System Files
.DS_Store
Thumbs.db

*.zip

# Generated FAQ files
src/assets/faqs/gui-faq-*.html

*.log
tests_output/
.e2e-chrome-profile/

# Emacs backup files
*~

# Generated by e2e
/test-results
# Playwright
node_modules/
/test-results/
/playwright-report/
/blob-report/
/playwright/.cache/
vendor/

# OS
.DS_store

*storybook.log
*.zip
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/*
!/src
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"plugins": ["prettier-plugin-astro", "prettier-plugin-svelte"],
"singleQuote": true,
"tabWidth": 4,
"useTabs": false
}
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{
}
66 changes: 66 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Contribute

Thank you for considering contributing to Zonemaster GUI! This document provides guidelines for contributing to the project.

## Project Overview

Zonemaster GUI is built with:
- [Astro](https://astro.build/) as the main framework
- [Svelte](https://svelte.dev/) for UI components
- [TypeScript](https://www.typescriptlang.org/) for type safety

## Development Setup

1. Clone the repository
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
```bash
npm run dev
```

## Code Style

We use [Prettier](https://prettier.io/) for code formatting with the following configuration:
- Single quotes
- 4 spaces for indentation
- No tabs

To format your code:
```bash
npx prettier --write .
```

## Testing

We use [Playwright](https://playwright.dev/) for end-to-end testing. Tests are located in the `e2e` directory.

To run tests:
```bash
npm run e2e
```

## GUI Modifications

Zonemaster GUI is designed to be cloned and customized for theming purposes. When making changes to the GUI, please be mindful of the following:

- **Be careful when renaming CSS class names** - Many themes may depend on these class names
- **Avoid deleting, renaming, or moving template files** without proper deprecation notices
- **Consider backward compatibility** when modifying component structures
- **Document any breaking changes** that might affect custom themes

While it's ultimately up to theme creators to handle conflicts when syncing with the main repository, we should minimize disruption where possible. For more information on theming, see the [THEMING.md](docs/THEMING.md) document.

## Pull Request Process

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Ensure tests pass
5. Submit a pull request

## Code of Conduct

Please be respectful and considerate of others when contributing to this project.
3 changes: 1 addition & 2 deletions Changes
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ v4.1.1 2023-09-08 (public fix version)

[Fixes]
- Corrects documentation links in FAQ for all languages
(#433)
(#433)


v4.1.0 2023-06-21 (public release version)
Expand Down Expand Up @@ -344,4 +344,3 @@ v2.0.0 2018-06-25
- The old Zonemaster-GUI is deprecated, and can, for the time being,
still be found in the old repository,
https://github.com/dotse/zonemaster-gui

99 changes: 29 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,53 @@
# Zonemaster Web GUI [![CI status](https://github.com/zonemaster/zonemaster-gui/actions/workflows/ci.yml/badge.svg)](https://github.com/zonemaster/zonemaster-gui/actions/workflows/ci.yml)

## Overview

### Purpose
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].

This module is the Web Interface part of the Zonemaster project. For an
overview of the Zonemaster software, please see the [Zonemaster repository].
## Prerequisites

### 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.

Before you install the Zonemaster Web GUI module, you need the Zonemaster
Engine test framework installed. Please see the [Zonemaster-Engine
installation] document.
## Installation

You also need a running Zonemaster-Backend component. Please see the
[Zonemaster-Backend installation] document.
There are two ways to install the Zonemaster GUI:

### Installation
### Quick Install (1 minute)
Download the release zip file, upload to your web server, and configure.

Follow the detailed [installation instructions].
### Full Customization (5 minutes)
Clone the repository, build, and deploy.

### Configuration
For detailed instructions, see [INSTALL.md](docs/INSTALL.md).

The configuration instructions for the Backend can be found in the [Backend
configuration] document.
## Development

The configuration instructions for the GUI can be found in the [GUI
configuration] document.
To set up your development environment:

### Documentation
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`

There is a [public documentation]. Some more specific documents can be found in
the [docs directory](docs/).
## Documentation

### Contribution
Refer to the [docs](/docs) directory for detailed information on:
- Installation and configuration
- Theming and customization
- Translation guide
- Testing
- UI documentation

This project was generated with Angular-CLI 1.6.8.
It uses the Angular 2+ framework with all its tools.

The source code of the application is available in `./src/app` folder.

The `components` folder is composed of subfolders that represent the main
components. Each folder of component contain three files:

* `*.component.css`: the component's style configuration;
* `*.component.html`: the component's HTML code;
* `*.component.ts`: the component's TypeScript code.

All assets are available in the `src/assets` folder. It is split by concern;
the style configurations are in the `css`, images are in the `images` folder, etc.

All translation files are in the `src/locale` folder.

The environment defaults of the application are in the `src/environments`
folder. `environment.ts` is used for development purposes, the
`environment.prod.ts` for production, and the `environment.test.ts` for testing.

In order to contribute:

* Install [Nodejs](https://nodejs.org)
* Fork the Zonemaster GUI repository on Github into your own user on Github.
* Clone your fork to your working environment.
* Go to the folder and install project dependencies with `npm install`
* Update configuration files in `src/assets/app.config.json` to add a Backend
API endpoint (or leave the default)
* Make your changes, test them and push them to your fork on Github
* From your fork, make a Pull Request against the zonemaster/zonemaster-gui
repository. Please always make the Pull Request against the develop branch.
* Thank you for your contribution!

#### Development server

Run `npm start` for a dev server. Navigate to `http://localhost:4200/en`.
The app will automatically reload if you change any of the source files.

#### Build

Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory.

#### Test

See [Testing](docs/Testing.md).
For contribution guidelines, see [CONTRIBUTE.md](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](LICENSE) file included in this respository.
This is free software under a 2-clause BSD license. The full text of the license can be found in the [LICENSE](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](https://undraw.co/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](https://undraw.co/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](https://undraw.co/license).

[Backend Configuration]: https://github.com/zonemaster/zonemaster/blob/master/docs/public/configuration/backend.md
[GUI Configuration]: https://github.com/zonemaster/zonemaster/blob/master/docs/public/configuration/gui.md
Expand Down
Loading