Niklan.net

This is a repository containing the source code for the https://niklan.net website.

Warning

It's not intended for use other than for educational purposes. Backward compatibility and support are not provided. If you want to ask me about that code, you can contact me directly.

💿 System requirements

• Drupal's system requirements if not mentioned below.
• PHP 8.3+
• (optional) Task for simplify things with Taskfile.yml.
• (optional) Yarn for running additional Quality Checks.

🖱️ Installation

• Clone repository

  git clone https://github.com/Niklan/niklan.net.git

• Install website

  task install

• Make a cup of ☕ or 🍵 and wait until the installation is finished.
• Open your local domain, e.g.: https://example.localhost

🧬 Quality Tools

The project has multiple quality tools used for CI. You can run all of them with:

task validate

Many issues can be fixed automatically, for that, just run:

task fix

If you want to run a specific validation or fixing, use dedicated tasks, like task validate/phpcs. Check Taskfile.yml or run task to find all available options.

🧪 Testing

f you want to run all test suites at once, you can use:

task test

You can also run individual test suites like task test/unit, or bypass a custom command by:

task phpunit -- --filter FooBarTest

🪤 Contribution

This is a personal project, I'm not expects any contributions to it. You can send Pull Request with typo fixes and maybe other improvements, but don't expect them to be merged. You better not to do that.

📬 Feedback

If you want to ask me about this project or its code base, feel free to contact me.