yawk/yawk.io

YaWK - Yet another Web Kit [work in progress]

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

Official Website: https://yawk.io
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 FEATURE LIST, latest closed issues and milestones 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 2024:

🧾 Currently on the ToDo list:

• Implement Chat GPT-4 API
• Add Content Builder (Improve WYSIWYG Editor)
• Update 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 4th Quarter 2024)
• and of course: check and fix language errors, major and minor bugs

🥇 Latest improvements / closed milestones

• [done] ✓ YaWK Update Feature
• [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 2024:

• 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 required
• 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.

---

🐣 But why?! - there are so many good 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.

---

YOU can be part of this project! 😎

You're welcome! 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. Any input is welcome!

---

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

(counter added 04-13-2023)

yawk.io's Issues

admin should be able to customize the search depth

solution: add search settings to db settings

display search results

solution: create backend page: admin/includes/search.php

add lite version of widget that runs w/o API key

build an instagram widget that display any single post. Should run without API key or registering @ instagram.

Pinterest Widget: add follow button

add follow button widget

update widget database

update .sql file

add menu title, change current field title to 'text'

I found out, that links in menus got just a title, not a text and title. For SEO reasons, it is important to fix this. Solution: in db(cms_menu) rename the current titled field "title" to "text" and add a new field "title". It's important adapt the code in admin/includes/menu-edit.php and system/classes/menu.php to get everything adjusted to the new situation.

YaWK Plugin Translation (system/plugins/*)

complete l10n of all system/plugins/*

Bug: publish checkbox at widget-edit page does not remember status

solution: Remove it (because not needed there!?) - or bugfix this publish checkbox

Bug: if a widget gets copied, the settings does not get copied too.

solution: check and add code in widget class / copy widget function

widget: CBA allow easy paste URL

Widget should be able to take the full URL (eg. https://cba.fro.at/331756) or the embed code.

make pace.js customizable

add settings color + height to database; add corresponding language tags

Twitter Widget: Embed Grid Timeline

embed grid layout

Twitter Widget: Embed Timeline

embed timeline with options in grid or timeline style

Bubbl.us Widget

add embed Bubbl.us Mindmap Widget

add radio buttons to getFormElements function

To cover all form elements, it is necessary to add the radio buttons to the getFormElement() function, located in \YAWK\settings

jPlayer Widget Basic Test Version

build a basic test version of this widget

Add time-publishing feature as used by pages.

solution: add date_published, date_unpublish field to db table, add code in classes, improve the view and implement a datetimepicker;

Tab at Settings Page

add a tab at system settings page: robots.txt - the file should be accessable and editable. Layout should be col-8-4 with a small description about robots.txt beneath the edit window.

SysLog Translation (system/classes/*)

l10n of every single syslog call; check all methods in every class.

YaWK core translation (admin/includes/*)

l10n of all messages and strings in admin backend pages.

Pinterest Profile Widget

embed any pinterest profile

add user statistics methods

add methods to

• count all registered users
• count all online users
• count all blocked users

sometimes vars could get lost if the language gets switched

solution: add setting to backend settings to let admins change the language there (via select field?)

add .sql import feature to database class

the method "import" makes it easy to import .sql data from file

Facebook Widget: embed FB Postings

embed any single, public posting from facebook.

build the view in admin/includes/stats.php

draw the user statistics nicley feat. chartJs in backend statistics page.

get all settings as array instead of single method calls

solution: 2 methods - one that gets all template settings data from the database, the other one draw the html form elements, depening on the settings. (As we did in settings class)

After adding a new widget, redirect to this widget edit page

solution: change setLocation path

Dashboard: Update Overview

create a static, but nice version of the dashboard page

add more template positions

template should cover every needed situation, from a small 1-position vcard to an enterprise newspaper page. to achieve this, it is needed to add way more clever positions (and add their settings into db & admin\includes\template-edit.php) - much work to do!

Improve widget edit overview: implement select fields and textareas

solution: add fields to cms_widget_types; build the classes & adapt widget overview

Pinterest Widget: add image pin widget

add image pin widget

Google Maps widget that runs without API key

custom language tags from own files (eg. /system/plugins/anyplugin/language/en-EN.ini

solution: a method in language class that can take a folder param and attach the file onto language object $lang[lang] (array)

Facebook Video Widget

embed any public video from facebook

add spotify widget

embed spotify to your website

add feature: visualize and set-up template positions

Template flexibility comes with positions. They need to be visualized. This could happen due a smaller"preview-Version" of all positions right next to the settings. The visualization could be a dashed line around every position. Each should be clickable. A bit jQuery magic to show up the settings of the position that have been selected would do the rest of the trick.

Twitter Widget: Tweet Button

let user drop a tweet

add missing bootstrap3 definitions to ReDesign

(eg. forms... - check which elements are still needed and implement them

Robots.txt Settings

add method to sys class to get/set robots.txt

Add description to widgets

solution: add text field to cms_widget_types;

build an installer class

requirements: the installer should check, whetever if its installed or not. user enters database connection, installer checks connection, if ok, db credentials needs to be written into the constructor; afterwards the installer inserts the .sql file with all the data and (demo content?) into db. the .htaccess file should get written, depending on user's se…

YaWK Widget Translation (system/widgets/*)

complete l10n of all system/widgets/*

refactor classes/language.php

rework some logical errors, set object params correctly

add a YouTube widget

youtube widget settings: width, height, url, allowfullscreen

language translation inconsistent and still incomplete

before going beta, it is required to translate every single string that gets used in backend.

Add widget title (every widget should have a unique, remarkable name)

solution: add varchar(255) field to cms_widget_types; build the view in admin/includes/widgets.php

prepare for beta: fix all issues that are marked as bug

at least, that ones that are known and fixable in that amount of time

Twitter Widget: Embed Single Tweet

embed any twitter posting

implement pace.js

add pace.js and pace.css to system/engines; add php code in AdminLTE class to include js + css if pace + settings are enabled