Initial commit

Signed-off-by: Kolja Nolte <kolja.nolte@gmail.com>

Author: thaikolja

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.idea/

README.md

@@ -1,93 +1,173 @@
 # Modern HTML Error Docs
 
+![License](https://img.shields.io/badge/License-MIT-yellow.svg) ![GitHub Stars](https://img.shields.io/github/stars/thaikolja/html-error-docs.svg?style=flat) ![GitHub Forks](https://img.shields.io/github/forks/YOUR_USERNAME/YOUR_REPOSITORY.svg?style=flat)
 
+A collection of modern, responsive, and brandable HTML error pages (e.g., 404, 500) designed to turn frustrating moments into memorable, on-brand experiences—with optional doses (customizable) of sarcasm, irony, and humor. Built for teams that want simple customization and a clean structure for deploying custom error docs across their web servers.
 
-## Getting started
+**Example for the error code 503:**
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+![screenshot](https://p.ipic.vip/k018xl.jpg)
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+## Features
 
-## Add your files
+-   ⚡️ **Responsive Design:** Optimized for various screen sizes, from mobile devices to large desktops.
+-   📦 **Single Source of Truth:** All error docs are managed in a central `messages.json` file for easy updates.
+-   🛟 **Fallback Mechanism:** Content is displayed even if JavaScript is disabled in the browser.
+-   🧹 **Organized Structure:** Clear separation of CSS, JavaScript, and image assets.
+-   ⚒️ **Customizable:** Easily modify docs, styling, and robot images to match your brand.
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+## Getting Started
 
-```
-cd existing_repo
-git remote add origin https://gitlab.com/thaikolja/modern-html-error-docs.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.com/thaikolja/modern-html-error-docs/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
+Although the error docs have been built for Linux servers, please note that the following paths and folders may not be accurate for your specific distribution.
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+### Prerequisites
 
-***
+-   A server running Linux
+-   An installed web server, e.g., Apache or Nginx
+-   Root access or enough permissions to change default error docs
+-   A modern web browser
 
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
+## Installation
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+> [!NOTE]
+>
+> For both installation versions, a Debian 12 server running Plesk, Apache, and Nginx is used. Some file paths may not be the same with your distribution.
+
+### Built Installation
+
+Already built version that only has to be moved to the server.
+
+1. Log in to your server as the root user
+
+2. Change into the directory where the error message files are being stored:
+
+   ```bash
+   cd /var/www/vhosts/.skel/0
+   ```
+
+3. Create a backup of the default error docs folder:
+
+   ```bash
+   zip -r error-docs-backup.zip error_docs
+   ```
+
+4. Use `curl` or `wget` to download the built files as a .zip archive:
+
+   ```bash
+   # Using wget
+   wget https://github.com/thaikolja/modern-html-error-docs/archive/refs/heads/main.zip
+   
+   # Using curl
+   curl -0 https://github.com/thaikolja/modern-html-error-docs/archive/refs/heads/main.zip
+   ```
+
+5. Unzip the downloaded file `main.zip`:
+
+   ```bash
+   unzip main.zip
+   ```
+
+6. Delete the folder `error-docs` and rename your extracted `main`:
+
+   ```bash
+   rm -r error-docs && mv main error-docs
+   ```
+
+7. `cd` into `error-docs` and use `ls -la`. You should see the following file structure:
+
+   ```bash
+   ├── assets
+   │   ├── css
+   │   │   └── main.min.css
+   │   ├── data
+   │   │   └── docs.json
+   │   ├── img
+   │   │   ├── robot-blue.avif
+   │   │   ├── robot-blue.png
+   │   │   ├── robot-blue.webp
+   │   │   ├── robot-red.avif
+   │   │   ├── robot-red.png
+   │   │   ├── robot-red.webp
+   │   │   ├── robot-yellow.avif
+   │   │   ├── robot-yellow.png
+   │   │   └── robot-yellow.webp
+   │   └── js
+   │       └── scripts.min.js
+   ├── bad_gateway.html
+   ├── bad_request.html
+   ├── forbidden.html
+   ├── internal_server_error.html
+   ├── maintenance.html
+   ├── method_not_allowed.html
+   ├── not_acceptable.html
+   ├── not_found.html
+   ├── not_implemented.html
+   ├── precondition_failed.html
+   ├── proxy_authentication_required.html
+   ├── request-uri_too_long.html
+   ├── unauthorized.html
+   └── unsupported_media_type.html
+   ```
+
+8. To change the docs for each template, open `assets/data/docs.json` and adjust them there.
+
+9. Restart your Apache or Nginx server or create a new website in your Plesk interface:
+
+   ```bash
+   # Apache
+   sudo systemctl restart apache2
+   
+   # Nginx
+   sudo systemctl restart nginx
+   ```
+
+10. 🥳 Your Modern HTML Error Docs are successfully installed!
+
+## Customization
+
+### Error docs
+
+All error docs are stored in `assets/data/docs.json`. You can edit this file to change the titles, descriptions, and robot speech for each error code.
+
+```json
+{
+  "404": {
+    "title": "Page Not Found",
+    "meta_description": "404 Page Not Found - Oops! The page you're looking for has vanished into the digital void.",
+    "robot_speech": "In a shocking turn of events, the page you're looking for has ceased to be. The internet is a cruel mistress, indeed.",
+    "main_message": "The page you're looking for has vanished into the digital void.",
+    "sub_message": "This robot is here to remind you that sometimes things just don't work out."
+  }
+  // ... other error codes
+}
+```
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+### Styling
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+Modify the `assets/css/main.css` file to change the visual appearance of the error pages. The CSS uses nesting for better readability and maintainability.
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+### Images
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+Replace or add new robot images in the `assets/img/` directory. Ensure you update the `srcset` and `src` attributes in the respective HTML files if you change the image filenames.
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+### JavaScript
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+The `assets/js/scripts.js` file handles the dynamic loading of docs from `docs.json` and can be extended for additional client-side functionality.
 
 ## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1.  Fork the Project
+2.  Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3.  Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4.  Push to the Branch (`git push origin feature/AmazingFeature`)
+5.  Open a Pull Request
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+## Author
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+* Kolja Nolte (kolja.nolte@gmail.com)
 
 ## License
-For open source projects, say how it is licensed.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+Distributed under the MIT License. See `LICENSE` for more information.