mirror of
https://github.com/zonemaster/zonemaster-gui.git
synced 2026-04-03 17:31:21 +02:00
112 lines
4.8 KiB
Markdown
112 lines
4.8 KiB
Markdown
Zonemaster Web GUI [](https://travis-ci.org/zonemaster/zonemaster-gui)
|
|
==========
|
|
|
|
### Purpose
|
|
This module is the Web Interface part of the Zonemaster project.
|
|
|
|
### Installation
|
|
|
|
Follow the detailed [installation instructions](docs/Installation.md).
|
|
|
|
##### Prerequisites
|
|
Before you install the Zonemaster Web GUI module, you need the
|
|
Zonemaster Engine test framework installed. Please see the
|
|
[Zonemaster Engine installation instructions](https://github.com/zonemaster/zonemaster-engine/blob/master/docs/Installation.md)
|
|
|
|
And also the the zonemaster-backend module installed. Please see the [Zonemaster
|
|
Backend installation](https://github.com/zonemaster/zonemaster-backend/blob/master/docs/Installation.md)
|
|
|
|
|
|
##### Configuration
|
|
|
|
Texts for configuring the backend are found in the [installation
|
|
instructions](docs/Installation.md).
|
|
|
|
The configuration instructions for the GUI can be found in the [configuration
|
|
documentation](docs/Configuration.md).
|
|
|
|
|
|
### Contribution
|
|
|
|
This project was generate with Angular-CLI 1.6.8 and then updating.
|
|
It use the Angular 2+ framework with all its tools.
|
|
|
|
The source code of the application is available in ``./src/app`` folder.
|
|
The ``app`` folder is structured as follow :
|
|
```
|
|
+-- components
|
|
+-- models
|
|
| +-- alter.ts : Alert model (level, message)
|
|
| +-- index.ts : module export
|
|
+-- pipes
|
|
| +-- filer.pipe.* : Filter a list based on a string
|
|
| +-- filer-by-categories.pipe.* : Filter the list of result by categories
|
|
| +-- romanize.pipe.* : Transform latin number to roman number (1 -> I, 2 -> II)
|
|
| +-- safe-html.pipe.* : Sanitize text to HTML
|
|
+-- services
|
|
| +-- alert.service.* : to display alert messages
|
|
| +-- app.service.* : to manage app configuration (api url, etc.)
|
|
| +-- dns-check.service.* : to communicate with the Zonemaster Backend API
|
|
+-- app.*
|
|
```
|
|
|
|
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
|
|
- ``*.component.html`` : The component's html
|
|
- ``*.component.ts`` : The component's typescript
|
|
|
|
All assets are available in ``src/assets`` folder.
|
|
It's split by concern, all translation files are in the ``i18n`` folder, the style in the ``css``,
|
|
images are in the ``images`` folder, etc.
|
|
|
|
The configurations files of the application are in the ``src/environments`` folder.
|
|
``environment.ts`` is use for development purpose, and the ``environment.prod.ts`` for production.
|
|
|
|
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 environment files in `/src/environments/` 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!
|
|
|
|
> In development mode, you probably have to enable [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) on your browser.
|
|
> The Cross-Origin Resource Sharing (CORS) performed by the browser blocks every AJAX request that does not match the exact host, protocol, and port of your site.
|
|
|
|
##### Development server
|
|
Run `npm start` for a dev server. Navigate to `http://localhost:4200/`. 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.
|
|
The script also change the FAQ markdown files to html files.
|
|
|
|
##### Test
|
|
See [Testing](docs/Testing.md).
|
|
|
|
##### Create a release zip file
|
|
Run 'npm run release' to create a zip file with dist folder and zonemaster.conf file. Then upload it in github.
|
|
|
|
### Documentation
|
|
|
|
Basically, the GUI is a serverless Angular application which use the Backend JSONRC API.
|
|
|
|
Other than the installation file, the [docs directory](docs/), contains a translation guide for the GUI
|
|
|
|
#### Security of our dependencies
|
|
Based on the output of [david](https://david-dm.org/) and [npm audit](https://docs.npmjs.com/cli/audit), we reguraly
|
|
update our dependencies with the latest secure version. Notice that we can't follow the rythm of new versions, so you could
|
|
get security warning during the installation of development dependencies.
|
|
|
|
#### Acknowledge
|
|
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.6.8.
|
|
|
|
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.
|