<h1>Attention: work in progress! <br><small>It's done when it's done. <small>(release: soon)</small></small></h1>

Official Website: <b>https://yawk.io</b><br>
Documentation: <b><a href="https://docs.yawk.io/namespaceYAWK.html" target="_blank">https://docs.yawk.io</a></b><br>
Latest Update: <b>24.6.15</b> <a href="https://update.yawk.io/" target="_blank">https://update.yawk.io/</a><br>
<h1>What is YaWK?</h1>
<b>YaWK</b> = <b>Y</b>et <b>a</b>nother <b>W</b>eb<b>K</b>it<br> 
<b>YaWK is a free, open-source-bundle solution</b> CMS to build, design and operate any modern webpage or web-app. Designed to be slick, fast and reliable. Steady in development. It brings together, what belongs together. YaWK uses HTML, CSS, MySQL, PHP and JavaScript to bundle Bootstrap, jQuery, AdminLTE, FontAwesome and much more of your favourite daily use web open source tools and combines them into a new base for your daily work.
<br><br>
<div style="text-align: center;">
  <img src="https://github.com/devicons/devicon/blob/master/icons/php/php-plain.svg" title="PHP" alt="PHP" width="25" height="25"/>&nbsp;
  <img src="https://github.com/devicons/devicon/blob/master/icons/javascript/javascript-original.svg" title="JavaScript" alt="JavaScript" width="25" height="25"/>&nbsp;
  <img src="https://github.com/devicons/devicon/blob/master/icons/mysql/mysql-original-wordmark.svg" title="MySQL"  alt="MySQL" width="25" height="25"/>&nbsp;
  <img src="https://github.com/devicons/devicon/blob/master/icons/bootstrap/bootstrap-original-wordmark.svg" title="Bootstrap" alt="Bootstrap" width="25" height="25"/>&nbsp;
  <img src="https://github.com/devicons/devicon/blob/master/icons/jquery/jquery-original-wordmark.svg"  title="jQuery" alt="jQuery" width="25" height="25"/>&nbsp;
  <img src="https://github.com/devicons/devicon/blob/master/icons/css3/css3-plain-wordmark.svg" title="CSS3" alt="CSS" width="25" height="25"/>&nbsp;
  <img src="https://github.com/devicons/devicon/blob/master/icons/html5/html5-original.svg" title="HTML5" alt="HTML" width="25" height="25"/>&nbsp;
</div>
<hr>
<h3><g-emoji class="g-emoji" alias="warning" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/26a0.png">🚀</g-emoji> Development status - <small>what has been done so far?</small></h3>
Short answer, a lot! - long answer: take a look at <a href="https://yawk.io/features.html" target="_blank" title="YaWK Feature List">FEATURE LIST</a>, <a href="https://github.com/YaWK/yawk.io/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc" target="_blank">latest closed issues</a> and <a href="https://github.com/YaWK/yawk.io/milestones?state=closed" target="_blank">milestones</a> 
to 
see what's going on and what has been done over the past few days, weeks, months and years.
<hr>
<h3><u>R O A D M A P for 2024: <small></small></u></h3>
<b><i></i></b>
<h3>🧾 Currently on the ToDo list:</h3>
<ul>
<li>Add Content Builder <b>(Improve WYSIWYG Editor)</b></li>
<li>Update official website <a href="https://yawk.io" target="_blank">https://yawk.io/</a> <i>(in progress!)</i></li>
<li>Migrate all doc blocks to doxygen <i><small>(nearly done)</small></i></li>
<li>Major Updates of all Assets and Social / Facebook Widgets </li>
<li>Add templates and demo pages <i><small>(scheduled until 4th Quarter 2024)</small></i></li>
<li><i><small>and of course: check and fix language errors, major and minor bugs</small></i></li>
</ul>
<h3>🥇 Latest improvements / closed milestones </h3>
<ul>
<li>[done] <a href="https://github.com/YaWK/yawk.io/milestone/81?closed=1" target="_blank"> ✓ Implemented <b>Chat GPT-4 API</b></a></li>
<li>[done] <a href="https://github.com/YaWK/yawk.io/milestone/80?closed=1" target="_blank"> ✓ YaWK Update Feature</a></li>
<li>[done] <a href="https://github.com/YaWK/yawk.io/milestone/11?closed=1" target="_blank"> ✓ Installer / Improve Setup process</a></li>
<li>[done] <a href="https://github.com/YaWK/yawk.io/milestone/78?closed=1" target="_blank"> ✓ Add support for multilingual FrontEnd (Content) Pages and Menus</a></li>
<li>[done] <a href="https://github.com/YaWK/yawk.io/milestone/65?closed=1" target="_blank"> ✓ Improved SubMenu Widget</a></li>
<li>[done] <a href="https://github.com/YaWK/yawk.io/issues/376" target="_blank"> ✓ Codebase update to ensure PHP 8 compatibility</a></li>
</ul>

<h3>📅 <u>ALSO PLANNED FOR 2024:</u></h3>
<ul>
<li>Add feature showcase</li>
<li>Update CSS Framework to completely support Bootstrap 5.x</li>
<li>Add support page <small><i>(and ticket system)</i></small></li>
<li>Add admin handbook <small><i>(pdf and / or html)</i></small></li>
<li>Add developer manual <small><i>(https://docs.yawk.io)</i></small></li>
</ul>
<b>Social media channels</b>
<ul>
<li>YouTube HowTo videos</li>
</ul>
<hr>
<h2>📥 Download</h2>
<h3>📦 latest version (24.6.15) from GitHub:</h3>

<b><a href="https://github.com/YaWK/yawk.io/archive/refs/heads/master.zip">https://github.com/YaWK/yawk.io/archive/refs/heads/master.zip</a></b>
<br>

Please remember: before you download this pre-release version: YaWK is currently in active development and NOT YET RELEASED. 
If you like, you can use it and get a sneak peek of the current development status. But please consider - YaWK is in open 
development phase and underlies <i>more or less frequent changes</i>. Due this fact, backward compatibility is not guaranteed 
at this stage.
<br><br>
Before YaWK is officially stated as "released", you will <i>always</i> get the current development version. After the 
first stable version is released, there will be a separate development/stable branch. <u>You should wait for 
the official first stable release before you use YaWK in productive environments.</u>
<br><br>I put a lot of work, time effort, heart and love in this project - so I will be happy about comments, stars, 
followers and / or code contributions. If you like this project, please consider to support it. Thank you!
<hr>
<h2>🔧 Setup / Installation</h2>
<i>There are two ways to load YaWK on your webserver:</i>
<ol>
<li><h3>🖥️ Installation via command line / shell access</h3><u>If you have root/shell access:</u> <b><code>git clone https://github.com/YaWK/yawk.io .</code></b><br>
this will download the latest version from GitHub to your current directory.
    <br><br>
    <i>or if you are using composer you can type: <b>composer create yawk/yawk.io -s dev</i></b>
    <br>
    <i>(afterwards move files from yawk.io folder to your project's root directory if necessary.)</i>
</li>
<li>
    <h3>📁 or Download the .zip + upload the Files using any FTP Client (eg. FileZilla)</h3>
    <u><b>This is most common for users with "typical" webhosting / webspace:</b></u> Download the .zip package, extract it on your computer and upload the extracted files to your webserver. Use any FTP client and upload the files to the root directory of your webserver.
</li>
</ol>
<h3>🚨 INSTALLATION REQUIREMENT NOTICE:</h3> Files must be accessible by your webserver's user process. <b>Make sure to set correct user/group permissions eg:</b><br>
<code>chown -R www-data:www-data yourfolder</code>
<br><u><i>(This is very important if you are running git clone from the shell with another user than the webserver's process...)</i></u>

Also make sure, that <u>the following files are writeable</u> by your webserver:<br>
<ul><li>.htaccess</li><li>/admin/.htaccess</li></ul>
These files need to have at least 755 (writeable for group) or 777 (writeable for all) permissions. 
If you are not sure, set it to 777. But beware! Don't forget to change it later, (eg. only writeable for owner) after setup is complete to ensure this file cannot be overridden by anybode else.

<h3>Minimum Server / Web Hosting Requirements:</h3>
<ul>
<li>PHP 8.x is required</li>
<li>MySQL 5.x or higher (MariaDB works also)</li>
<li>Apache 2.x or nginx Webserver</li>
<li>MOD_REWRITE enabled</li>
</ul>

<h3>How to run Installation / Setup</h3>
After you finished uploading YaWK to your webserver, make sure all rights are set correctly (as explained above) and simply call www.yourwebsite.tld in your browser. If the server is correctly configured, you will see step 1/5 of the setup process where you can select your desired Language. (currently english or german) <br><br>The Installer will guide you through 5 pretty self-explanatory steps.<br>
<h3>🔑 Admin Login</h3>
After setup is complete, you can login to the admin area with the credentials you have set during setup. The admin area is located at <b>www.yourwebsite.tld/admin</b>.<br>
<h3>📚 Documentation</h3>
For more detailed information, please visit the official documentation at <a href="https://docs.yawk.io" target="_blank">https://docs.yawk.io</a>.<br>
<h3>🔧 Troubleshooting / ERROR 500 / white page after Installation</h3>
If you are getting a blank (white) page with no further error message, there might be a problem caused with the default settings defined in .htaccess file. This could be a wrong or false caching configuration of your server, missing modules, or (mostly) wrong file/folder permissions or wrong ownership. Rarely it has to do with something else. Please check your server's error log in that case. Feel free to get in contact if you are not able to solve the error on your own.<br>
<hr>
<h3>📝 License</h3>
YaWK is licensed under the MIT License. Other licenses may apply to third-party libraries and assets. Please check the license files and the documentation for more information. YaWK is free software and can be used by anyone.<br>
<h3>🐣 But why are you running this?! - there are sooo many CMS around...</h3>
YaWK is an open source project, <b>built for everyone.</b> Actually there is <i>no big business company or foundation behind it - (yet!)</i> At the moment it is still <i>(mainly)</i> a one man show, - exclusively developed for my own, personal purpose. <i>I started this project because I was not satisfied with all other solutions at that time</i>. So I took the challenge and started developing an overall tool that fits my personal needs. Originally it was not meant to public. But the bigger the project growed, the more people told me to make it accessable to the public crowd.
After spending a lot of my lifetime on this project, I decided to follow my friends - I've uploaded it to GitHub and kept the repository private until the status of the project has got to a level where others can make use out of it. Though all efforts of <i>"getting it to the point"</i>, this project is not finished yet - and probably never will be. It is free software! and will stay in development, as long as I <i>(or somebody else)</i> take care about it.
<hr>
<h3>YOU can be part of this project! 😎</h3>
<u></u>You're welcome!</u> You have found a bug? Please let us know! Do you want to request a feature? Feel free to get in contact - open an issue or pull request. <b>Any input is welcome!</b></i>
<h3>📧 Contact</h3>
If you have any questions, feel free to contact me via email: <a href="mailto:danielretzl@gmail.com">@DR</a><br>
<hr>
<h4><i>Check back again soon and stay tuned for upcoming website and project updates!</i></h4>

<img src="https://komarev.com/ghpvc/?username=YaWK&style=flat-square&color=blue&label=Repository+Hit+COUNTER:" alt="Profile Hit Counter"/>
<br><small><i>(counting since 2023-04-13) </i></small>