Attention: work in progress!
It's done when it's done. (release: soon)

Documentation: https://docs.yawk.io

What is YaWK?

YaWK = Yet another WebKit
YaWK is a free, open-source-bundle solution 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.

---

Development status - what has been done so far?

Short answer, a lot! - long answer: take a look at the recent commits, closed issues, latest closed milestones and current open projects to see what's going on and what has been done over the past few days, weeks, months and years.

---

R O A D M A P for 2023:

Currently on the ToDo list:

• YaWK Update Feature (in progress!)
• Brand new official website https://yawk.io/ (in progress!)
• Migrate all doc blocks to doxygen (nearly done)
• Major Updates of all Assets and Social / Facebook Widgets
• Add templates and demo pages (scheduled until end of 2023)
• and of course: check and fix language errors, major and minor bugs

Latest improvements / closed milestones

• [done] ✓ Installer / Improve Setup process
• [done] ✓ Add support for multilingual FrontEnd (Content) Pages and Menus
• [done] ✓ Improved SubMenu Widget
• [done] ✓ Codebase update to ensure PHP 8 compatibility

ALSO PLANNED FOR 2023:

• Add feature showcase
• Update CSS Framework to completely support Bootstrap 5.x
• Add support page (and ticket system)
• Add admin handbook (pdf and / or html)
• Add developer manual (https://docs.yawk.io)

Social media channels

• YouTube HowTo videos

---

Download Notes:

Please remember: before you download this pre-release version: YaWK is currently in active development and NOT YET RELEASED. If you like, you can get a sneak peek - feel free to download the latest current development version from GitHub:

https://github.com/YaWK/yawk.io/archive/refs/heads/master.zip

But please consider - YaWK is in constant development and underlies nearly daily changes. Due this fact it can not be guaranteed that everything work in this test version as expected. You may possibly encounter some major or minor warnings or bugs.

Before YaWK will be officially released, you will always get the current development version. After the first version is officially released, there will be a seperate development branch. You should wait for the official first release before you use YaWK in productive environment. I'm happy about comments, stars, followers and / or code contributions. Thank You!

---

Setup / Installation

There are two ways to load YaWK on your webserver:

1. If you have root/shell access: git clone https://github.com/YaWK/yawk.io
   
   or if you are using composer you can type: composer create yawk/yawk.io -s dev
   
   (afterwards move files from yawk.io folder to your project's root directory if necessary.)
   
   ATTENTION: Files must be accessible by webserver user & group. Make sure to check/set correct user/group permissions (example: chown -R www-data:www-data yourfolder)
   
   
2. If you're using a webhost: 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.

Minimum Server / Web-hosting Requirements:

• PHP 8.x is recommended
• MySQL 5.x or higher (MariaDB works also)
• Apache 2.x or nginx Webserver
• MOD_REWRITE enabled

Installation / Setup HowTo

When YaWK is uploaded to your webserver, simply call www.yourwebsite.tld in your browser. If the server is correctly configured, you will see step 1/5 of the setup process. The installation guide you through 5 steps and is pretty self-explanatory.

Why all this? - there are so many CMS around...

YaWK is an open source project, built for everyone. Actually there is no big business company or foundation behind it - (yet!) At the moment it is still (mainly) a one man show, - exclusively developed for my own, personal purpose. I started this project because I was not satisfied with all other solutions. 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 "getting it to the point", this project is not finished yet - and never will be. It will stay in development, as long as I or somebody else take care about it.

---

Do you want to be part of this project?

If you want to put your manpower and knowledge into this project, you're welcome! Please feel free to contact me. Tell me how you think you can help this project. Your input will be welcome - everything will get better - particularly with a little help from some friends.

---

Check back again soon and stay tuned for upcoming website and project updates!