docs: reorganize project README
This commit is contained in:
1 parent
2fbeeef59d
commit
2a063481a6
1 file changed
+58
-10
@@ -1,16 +1,64 @@
|
||||
# HTML Simple Maintenance Page
|
||||
# Maintenance Website
|
||||
|
||||
### [πββοΈ Website Preview](https://lechner-systems.at/)
|
||||
A lightweight maintenance page served as a static website.
|
||||
|
||||
### πͺͺ License
|
||||
Icons: [Icons8.com](https://icons8.com/)
|
||||
## Preview
|
||||
|
||||
Modified by Julian Lechner.
|
||||
Based on Simple Maintenance Page by theoricher.
|
||||
Licensed under GNU GPL v3.
|
||||
[Open the live preview](https://lechner-systems.at/)
|
||||
|
||||
## π€ Enjoy?
|
||||
## Technology
|
||||
|
||||
Give it a star β on [Gitea](https://git.lechner-systems.at/FrauJulian/Personal-Portfolio-Website)!
|
||||
- HTML, CSS, and vanilla JavaScript
|
||||
- Nginx
|
||||
- Docker and Docker Compose
|
||||
|
||||
### Greetings from Austria! β°οΈ
|
||||
## Features
|
||||
|
||||
- Selects a maintenance message from the browser's preferred language, with English fallback
|
||||
- Supports English, German, Slovak, Czech, Dutch, Swedish, Norwegian, Polish, Italian, French, Spanish, Slovenian, and Danish
|
||||
- Provides email, abuse, phone, imprint, and status links
|
||||
|
||||
## Project Architecture
|
||||
|
||||
- `index.html` β page content and contact links
|
||||
- `style.css` β page layout and styling
|
||||
- `script.js` β language selection
|
||||
- `images/` β page images and icons
|
||||
- `nginx.conf` β web server configuration
|
||||
- `Dockerfile` β production image definition
|
||||
- `docker-compose.yml` β production service configuration
|
||||
|
||||
## Setup
|
||||
|
||||
### Development
|
||||
|
||||
From the project root, start a local static server:
|
||||
|
||||
```sh
|
||||
python -m http.server 8000
|
||||
```
|
||||
|
||||
Open <http://localhost:8000>.
|
||||
|
||||
### Production
|
||||
|
||||
Requires Docker Compose and access to the configured image registry. Copy the example environment file, set `IMAGE_TAG` if needed, then start the service:
|
||||
|
||||
```sh
|
||||
cp .env.example .env
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
The page is available at <http://localhost:8080> by default. Set `MAIN_PORT` in `.env` to change the host port.
|
||||
|
||||
## Tests
|
||||
|
||||
There is no dedicated test suite. CI checks JavaScript syntax with `node --check` and builds the Docker image.
|
||||
|
||||
## Guidelines
|
||||
|
||||
Use the issue templates in [`.gitea/ISSUE_TEMPLATE`](.gitea/ISSUE_TEMPLATE) for bug reports and feature requests.
|
||||
|
||||
## LICENSE
|
||||
|
||||
The project is licensed under the [GNU General Public License v3](LICENSE). Icons by [Icons8](https://icons8.com/).
|
||||
Reference in new issue
Block a user