mirror of
https://github.com/wekan/wekan.git
synced 2025-12-16 23:40:13 +01:00
Reorganized Design Docs
This commit is contained in:
Lauri Ojansivu
parent
1a98c86a37
commit
f34490fe28
8 changed files with 45 additions and 373 deletions
|
|
@ -1,136 +0,0 @@
|
|||
## WeKan Interview 2023-12-08 starts at 22min 22sec
|
||||
|
||||
https://www.youtube.com/watch?v=ke-mbnZM3zE
|
||||
|
||||
## Screenshot of Meteor WeKan
|
||||
|
||||
<img src="https://wekan.fi/wekan-dark-mode.png" width="100%" alt="Meteor WeKan screenshot" />
|
||||
|
||||
## Description of Meteor WeKan
|
||||
|
||||
- WeKan Open Source kanban with MIT license.
|
||||
- Translated to 70+ languages https://explore.transifex.com/wekan/wekan/
|
||||
- Used in most countries of the world https://snapcraft.io/wekan
|
||||
- Biggest user have about 30k users, using many pods at Kubernetes
|
||||
- Changelog https://github.com/wekan/wekan/blob/main/CHANGELOG.md
|
||||
- Commercial Support at https://wekan.fi/commercial-support/ . Currently looking who could sponsor more of maintenance and development.
|
||||
|
||||
## How much effort to create Meteor WeKan, in COCOMO model
|
||||
|
||||
- WeKan 134k lines of code: 34 years of effort, 316 contributors https://openhub.net/p/wekan
|
||||
- Meteor.js, 224k lines of code: 59 years of effort, 819 contributors https://openhub.net/p/meteor-js
|
||||
- Since December 2016, WeKan maintainer https://github.com/xet7 :
|
||||
- has added and removed about 4M lines of code https://github.com/wekan/wekan/graphs/contributors
|
||||
- https://openhub.net/accounts/xet7
|
||||
|
||||
## Meteor WeKan Browser support
|
||||
|
||||
- Javascript enabled Desktop and Mobile Safari/Chromium/Firefox based browsers
|
||||
- Apps at Play Store, Windows Microsoft Store, Ubuntu Touch OpenStore https://github.com/wekan/wekan/wiki/Browser-compatibility-matrix
|
||||
- Alternatively, for self-hosted WeKan, create PWA icon https://github.com/wekan/wekan/wiki/PWA
|
||||
- Using WeKan with big touchscreen https://github.com/wekan/wekan/wiki/Touch-Screen-support
|
||||
|
||||
## Meteor WeKan Server
|
||||
|
||||
- Meteor.js 2.x, Node.js 14.x https://github.com/wekan/node-v14-esm/releases/tag/v14.21.4 , MongoDB 6.x
|
||||
- CPU: amd64, arm64, s390x, Source Bundle at https://github.com/wekan/wekan/wiki/Raspberry-Pi
|
||||
- Windows On-Premise: https://github.com/wekan/wekan/wiki/Offline
|
||||
- Mac: Docker, or at https://github.com/wekan/wekan/wiki/Mac
|
||||
- Newest at platforms: Source Bundle, Snap Candidate, Docker, Kubernetes https://wekan.fi
|
||||
- Platforms that will be updated to be up-to-date: Snap Stable, Sandstorm, UCS https://wekan.fi
|
||||
|
||||
## Meteor WeKan Features
|
||||
|
||||
- [WeKan Design Principles](https://github.com/wekan/wekan/wiki/Design-Principles)
|
||||
- Realtime UI. When someone makes change, like drag card or add text, everyone will see changes immediately. This is because Meteor listens to MongoDB change stream, and updates UI. For some rare cases, there needs to be reload of page, those need to be fixed.
|
||||
- Whitelabel: Change product name and product image at login screen and board left top corner. Not changing favicon, because there are 100+ favicons for different devices.
|
||||
- Drag Drop at Desktop and Mobile:
|
||||
- Board Icons, Swimlanes, Lists, Cards, Checklists, Checklist Items
|
||||
- Drag handles, per screen https://github.com/wekan/wekan/wiki/Drag-Drop
|
||||
- Some features similar to Trello and Jira. Some features not in Trello and Jira.
|
||||
- IFTTT Rules like Trello Butler https://github.com/wekan/wekan/wiki/IFTTT , translated to all supported languages. Trello Butler is only In English.
|
||||
- Many Assignees like in Jira.
|
||||
- Change background image and Card Cover. Change Theme. Change color of Boards, Swimlane, List, Card, Label.
|
||||
- Markdown at: Board name and description, Swimlane, List, Card title and description, Checklist and Checklist Item, Subtask title, https://github.com/wekan/wekan/wiki/Wekan-Markdown
|
||||
- Emoji https://github.com/wekan/wekan/wiki/Emoji
|
||||
- MathML
|
||||
- Preview card attachment image and PDF
|
||||
- Show Start at End Dates of card at Calendar of Swimlanes/Lists/Calendar dropdown menu
|
||||
- Custom Fields https://github.com/wekan/wekan/wiki/Custom-Fields
|
||||
- Subtasks https://github.com/wekan/wekan/wiki/Subtasks
|
||||
- Planning Poker / Scrum Poker at Card https://github.com/wekan/wekan/wiki/Planning-Poker . No other card games yet ;)
|
||||
- For board actions, like move card etc, Per Board and Global Outgoing and 2-way webhooks to Chat (RocketChat, Slack, Discord etc), NodeRED, or PHP webhook receiver like https://github.com/wekan/webhook
|
||||
- At top right username menu:
|
||||
- Search All Boards, with search options
|
||||
- Public Boards. Board can be set private or public. At Admin Panel is option to disable public boards, so all boards are private.
|
||||
- Change Language
|
||||
- My Cards and Due Cards: Show cards where you are member or assignee, from all boards
|
||||
- At top of current board:
|
||||
- Filter cards, by user etc
|
||||
- Multi-Selection, checkmark and drag many cards at once
|
||||
- Sort current board
|
||||
- Python and PHP based additional features https://github.com/wekan/wekan/wiki/Python
|
||||
- Admin Panel:
|
||||
- Organizations/Teams/People. Impersonate User, logged to database when someone uses that feature.
|
||||
- Customize Translations https://github.com/wekan/wekan/wiki/Customize-Translations
|
||||
|
||||
## Technical details
|
||||
|
||||
- Reactive Cache
|
||||
- mfilser tested speed improvement for half a year, and finally made huge PR to WeKan v7.00 to make all of WeKan use Reactive cache https://github.com/wekan/wekan/pull/5014
|
||||
- Reactive Cache Repo https://github.com/wekan/meteor-reactive-cache , xet7 updated dependencies
|
||||
- Big performance improvements https://github.com/wekan/wekan/issues/5000
|
||||
- Using same style of API for client and serverside
|
||||
- Use more ReactiveCache than MiniMongo
|
||||
- Optimizing and Debugging Meteor, reducing size, links to WeKan dependencies https://github.com/wekan/wekan/wiki/Debugging
|
||||
- Custom OIDC/OAuth2 login
|
||||
- Repo https://github.com/wekan/wekan/tree/main/packages/wekan-oidc
|
||||
- Features:
|
||||
- At Admin Panel, you can change text of login page button `Login with OIDC`
|
||||
- Auth0 https://github.com/wekan/wekan/wiki/OAuth2#auth0 . This did take about half year to implement by xet7, was not available anywhere else for Meteor.
|
||||
- Oracle OIM. https://github.com/wekan/wekan/wiki/Oracle-OIM . For this, customer provided some code. xet7 added fix to make login work even when some login field was missing data, by taking data from other field, all this while xet7 did not have access to customers Oracle OIM, just guessing about what code to add, and it worked.
|
||||
- GitLab https://github.com/wekan/wekan/wiki/OAuth2#gitlab-providing-oauth2-login-to-wekan
|
||||
- RocketChat https://github.com/wekan/wekan/wiki/OAuth2#rocketchat-providing-oauth2-login-to-wekan
|
||||
- Nextcloud https://github.com/wekan/wekan/wiki/Nextcloud
|
||||
- ADFS 4.0 using OAuth2 and OpenID https://github.com/wekan/wekan/wiki/ADFS
|
||||
- Azure https://github.com/wekan/wekan/wiki/Azure
|
||||
- Keycloak https://github.com/wekan/wekan/wiki/Keycloak
|
||||
- Google login https://github.com/wekan/wekan/wiki/Google-login
|
||||
- Custom LDAP
|
||||
- LDAP https://github.com/wekan/wekan/wiki/LDAP
|
||||
- LDAP AD Simple Auth https://github.com/wekan/wekan/wiki/LDAP-AD-Simple-Auth
|
||||
- Default board for users https://github.com/wekan/wekan/pull/5098
|
||||
- Brute Force Accounts Lockout https://github.com/wekan/wekan/wiki/Accounts-Lockout
|
||||
- Markdown, Emoji, MathML, sanitizing https://github.com/wekan/wekan/blob/main/packages/markdown/src/template-integration.js
|
||||
- Many security fixes from Responsible Disclosure https://wekan.fi/hall-of-fame/
|
||||
|
||||
## Upcoming Features
|
||||
|
||||
- CAS https://github.com/wekan/wekan/wiki/CAS
|
||||
- SAML https://github.com/wekan/wekan/wiki/SAML
|
||||
|
||||
## Video
|
||||
|
||||
- Creator of WeKan, mquandalle (Maxime Quandalle) https://www.youtube.com/watch?v=N3iMLwCNOro
|
||||
- https://github.com/wekan/wekan/wiki/FAQ#what-was-wekan-fork--wefork
|
||||
- Maintainer of WeKan since December 2016, xet7 (Lauri Ojansivu), about WeKan Multiverse at EU NGI Dapsi https://www.youtube.com/watch?v=BPPjiZHVeyM . More about Multiverse at https://github.com/wekan/wekan/wiki/WeKan-Multiverse-Roadmap
|
||||
|
||||
## Maybe?
|
||||
|
||||
- https://github.com/frozeman/meteor-persistent-minimongo2
|
||||
|
||||
## Upcoming upgrades to Meteor 3.0
|
||||
|
||||
- This Week in MeteorJS: 22 September 2023 https://www.youtube.com/watch?v=UWVL1xUP9r0
|
||||
- There Jan Dvorak IV https://github.com/StorytellerCZ commented chat: "We should do deep dive into WeKan!"
|
||||
- So here is The Deep Dive!
|
||||
- Questions for upcoming "This Week in MeteorJS", some already mentioned to be upcoming:
|
||||
- How to upgrade dependencies to Meteor 3.0 ? Some answer was to mention Meteor version at package dependency:
|
||||
<img src="https://wekan.fi/upgrade-meteor3-new.png" width="100%" alt="Meteor 3.0 upgrading dependencies" />
|
||||
- But what if adding dependency adds some more error messages? Probably that depends on error message, like here when
|
||||
trying to upgrade to Meteor 3.0 alpha 15: https://github.com/wekan/wekan/issues/5142
|
||||
- https://forums.meteor.com/t/my-journey-towards-meteor-3-0/60001/23
|
||||
- https://github.com/bratelefant/Meteor-Files
|
||||
- https://github.com/bratelefant/meteor-roles
|
||||
- https://github.com/bratelefant/meteor-multitenancy
|
||||
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
## WeKan Design Principles
|
||||
|
||||
- 2024-08 Design discussion here: https://github.com/wekan/wekan/discussions/5507
|
||||
- Original WeKan Design:
|
||||
- Uses WeKan style confirm popups `Popup.afterConfirm(` , translations etc. Please look at existing code to keep same style.
|
||||
- Kanban, the good parts. Like was done when figuring out best design for Swimlanes https://github.com/wekan/wekan/issues/955
|
||||
- Intuitive, easy to figure out, prevent messing up something https://github.com/wekan/wekan/wiki/Monkey-Proof-Software
|
||||
- Polished UI/UX
|
||||
- Menu options are there where you would expect then to be.
|
||||
- Try to fix anything unexpected.
|
||||
- New features added there where it makes most sense.
|
||||
- Not too many toggles and settings, because that is worse. For example, Discord settings has too many toggles and settings. Just select some default.
|
||||
- FOSS with MIT license
|
||||
- Swimlanes
|
||||
- All the use cases of WeKan feature/fix contributors
|
||||
- Cross-platform. Support many CPU/OS/Browsers for Desktop and Mobile.
|
||||
- Support many browsers https://github.com/wekan/wekan/wiki/Browser-compatibility-matrix . Add support for more.
|
||||
- PWA https://github.com/wekan/wekan/wiki/PWA
|
||||
- On-Premise:
|
||||
- Linux amd64/arm64/s390x
|
||||
- https://wekan.fi/install/
|
||||
- https://github.com/wekan/wekan/wiki/Raspberry-Pi
|
||||
- Windows https://github.com/wekan/wekan/wiki/Offline
|
||||
- Mac https://github.com/wekan/wekan/wiki/Mac
|
||||
- Not like other software:
|
||||
- But note that design of all software changes often, when they are in active development.
|
||||
- Not bad parts of Trello:
|
||||
- Not the exact design of Trello https://github.com/wekan/wekan/wiki/FAQ#why-does-wekan-look-so-different-now-compared-to--v09
|
||||
- Not so many duplicate menus and texts like Trello
|
||||
- Not so much empty space
|
||||
- Some good parts of Trello:
|
||||
- Import from Trello
|
||||
- Shortcuts https://github.com/wekan/wekan/issues/1878
|
||||
- IFTTT Rules like Trello Butler https://github.com/wekan/wekan/wiki/IFTTT
|
||||
- Progress bar of checklist
|
||||
- Some good parts of Jira:
|
||||
- Multiple assignees
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
|
||||
|
||||
## 1. What is Monkey Proof Software?
|
||||
|
||||
Someone told xet7, that WeKan is Monkey Proof Software. Jira is not Monkey Proof Software. Here we are exploring what it means.
|
||||
|
||||
## 2. Proofing
|
||||
|
||||
a) Monkey Proof testing of laptop https://www.youtube.com/watch?v=QxCV0bZGE00 . There are also some info at Internet how to make sure monkeys do not mess up apartments, trashcans etc.
|
||||
|
||||
b) https://en.wikipedia.org/wiki/Proofing
|
||||
|
||||
> Proofing may refer to:
|
||||
>
|
||||
> - [Proofing (armour)](https://en.wikipedia.org/wiki/Proofing_(armour)), the testing of armour for its defensive ability
|
||||
> - [Proofing (baking technique)](https://en.wikipedia.org/wiki/Proofing_(baking_technique)), a rest period during the fermentation of bread dough
|
||||
> - [Proofing (prepress)](https://en.wikipedia.org/wiki/Prepress_proofing), a concept in print production
|
||||
> - [Proof testing](https://en.wikipedia.org/wiki/Proof_test), a form of stress test to demonstrate the fitness of a load-bearing structure
|
||||
|
||||
c) https://nl.wikipedia.org/wiki/Foolproof mentions "De Engelse termen foolproof, idiot proof, monkey proof"
|
||||
|
||||
d) https://en.wikipedia.org/wiki/Idiot-proof
|
||||
|
||||
> In modern [English](https://en.wikipedia.org/wiki/English_language) usage, the informal term idiot-proof or foolproof describes designs that cannot be misused either inherently, or by use of [defensive design](https://en.wikipedia.org/wiki/Defensive_design) principles. The implication is that the design is usable even by someone of low intelligence who would not use it properly.
|
||||
|
||||
## 3. Defensive design
|
||||
|
||||
Mentioned at https://en.wikipedia.org/wiki/Defensive_design
|
||||
|
||||
> Defensive design is the practice of planning for [contingencies](https://en.wikipedia.org/wiki/Contingency_plan) in the [design](https://en.wikipedia.org/wiki/Design) stage of a project or undertaking. Essentially, it is the practice of anticipating all possible ways that an end-user could misuse a device, and designing the device so as to make such misuse impossible, or to minimize the negative consequences. For example, if it is important that a plug is inserted into a socket in a particular orientation, the socket and plug should be designed so that it is physically impossible to insert the plug incorrectly. Power sockets are often keyed in such a manner, to prevent the transposition of live and neutral. They are also recessed in the wall in a way that makes it impossible to touch connectors once they become live.
|
||||
|
||||
## 4. Defensive Design in Computer software
|
||||
|
||||
> Defensive design in [software engineering](https://en.wikipedia.org/wiki/Software_engineering) is called [defensive programming](https://en.wikipedia.org/wiki/Defensive_programming). [Murphy's law](https://en.wikipedia.org/wiki/Murphy%27s_law) is a well-known statement of the need for defensive design, and also of its ultimate limitations.
|
||||
>
|
||||
> [Software design](https://en.wikipedia.org/wiki/Software_design) entails many ways so that software can be designed to operate more safely.
|
||||
>
|
||||
> - Data entry screens can "sanitize" inputs, e.g. numeric fields contain only digits, signs and a single decimal point if appropriate.
|
||||
>
|
||||
> - Inputs can be sanity checked for legitimate values, e.g. for counts of workplace injuries (or number of people injured) the number can be 0 but can't be negative and must be a whole number; for number of hours worked in one week the amount for any specified employee can be 0, can be fractional, but can't be negative and can't be greater than 168, nor more than 24 times the number of days they were in attendance.
|
||||
>
|
||||
> - A word processor requested to load a saved document should scan it to ensure it is in good form and not corrupted. If it is corrupted, the program should say so, then either accept the partial document that was valid, or refuse the entire document. In either case it should remain running and not quit.
|
||||
|
||||
## 6. Monkey Testing
|
||||
|
||||
https://en.wikipedia.org/wiki/Monkey_testing
|
||||
|
||||
## 7. Why Custom CSS/Javascript is not Monkey Proof
|
||||
|
||||
@xet7 wrote at https://github.com/wekan/wekan/issues/4167#issuecomment-1151557772 to this comment
|
||||
|
||||
> Wekan functions better on pretty much all fronts except for customization options given that one can directly change kanboard CSS to fit their needs.
|
||||
|
||||
From @xet7
|
||||
|
||||
Custom CSS and Javascript is very dangerous: https://github.com/wekan/wekan/issues/3086#issuecomment-627615017
|
||||
|
||||
> I had to previously find a way [how to fix Custom Javascript in RocketChat](https://forums.rocket.chat/t/big-issue-with-custom-javascript/261/4?u=xet7) because it broke my RocketChat install.
|
||||
>
|
||||
> Also, previously I had to [fix XSS bug](https://github.com/wekan/wekan/blob/main/CHANGELOG.md#v385-2020-03-23-wekan-release) because adding Javascript to input fields did run that Javascript code.
|
||||
>
|
||||
> I'll try to find is there a safe way to do this.
|
||||
|
||||
Correct solution is to add setting like here https://github.com/wekan/wekan/issues/4558
|
||||
|
||||
WeKan target group is those that call WeKan "Monkey Proof Software", so that WeKan is easy to figure out, user friendly, polished enough. Jira is not "Monkey Proof Software".
|
||||
|
||||
If someone is asking for "Custom CSS", that means they are programmers, and should be sending PRs to WeKan with fixes to UI, new settings, etc, so that WeKan works safely without "Custom CSS", for normal non-programmer people.
|
||||
|
||||
## 6. Towards more Monkey Proof Software
|
||||
|
||||
In Progress:
|
||||
- Optimizing speed
|
||||
- Minimize frontend and backend code
|
||||
- Fixing bugs
|
||||
|
|
@ -1,372 +0,0 @@
|
|||
## What is not Cross-Platform
|
||||
|
||||
- Requires CPU to support AVX
|
||||
- Bun Javascript Engine https://bun.sh
|
||||
- MongoDB 5.x and newer https://github.com/turnkeylinux/tracker/issues/1724#issuecomment-2351544191
|
||||
- Does not work at s390x
|
||||
- Bun Javascript Engine https://github.com/oven-sh/bun/issues/2632
|
||||
- Deno Javascript Engine https://github.com/denoland/deno/issues/20212#issuecomment-1756663943
|
||||
- Lazarus IDE https://www.lazarus-ide.org
|
||||
- FreePascal programming language https://www.freepascal.org
|
||||
- TigerBeetle database https://github.com/tigerbeetle/tigerbeetle/issues/2241
|
||||
|
||||
## What is Cross-Platform
|
||||
|
||||
- Works at s390x
|
||||
- Programming languages
|
||||
- Node.js https://nodejs.org https://github.com/wekan/ferretdb/tree/main/node-deno-bun (not Deno or Bun)
|
||||
- C89 https://github.com/xet7/darkesthour
|
||||
- PHP https://github.com/wekan/php
|
||||
- Go https://github.com/wekan/wekango
|
||||
- Tcl/Tk
|
||||
- Web Frameworks
|
||||
- V veb https://github.com/vlang/v/issues/18737
|
||||
- Gambas https://github.com/wekan/hx/tree/main/prototypes/ui/gambas
|
||||
- Python Py4Web https://py4web.com
|
||||
- Ruby on Rails https://github.com/werot
|
||||
- WeKan Studio https://github.com/wekan/wekanstudio
|
||||
- Works at AmigaOS 3.x/4.x/MorphOS/AROS, Win/Mac/Linux
|
||||
- Web frameworks
|
||||
- FreePascal https://github.com/wekan/wami
|
||||
- GUI
|
||||
- BBC Basic https://www.bbcbasic.net/wiki/doku.php?id=converting_20programs_20from_20risc_20os_20to_20windows
|
||||
- Godot https://godotengine.org , https://github.com/godotengine/godot
|
||||
- Redot https://www.redotengine.org , https://github.com/Redot-Engine/redot-engine
|
||||
- HaxeUI https://haxeui.org
|
||||
|
||||
## Prototype Strategy
|
||||
|
||||
- Try building many prototypes, see what works
|
||||
- https://en.wiktionary.org/wiki/throw_things_at_the_wall_and_see_what_sticks
|
||||
|
||||
## Future
|
||||
|
||||
- Will this happen? With what tech? See https://github.com/wekan/wekan/blob/main/FUTURE.md
|
||||
- You can comment at https://github.com/wekan/wekan/issues/4578
|
||||
- You can help by sending PR to any prototype repo mentioned below
|
||||
|
||||
## Wishes to all web frameworks
|
||||
|
||||
- Documentation about how to upgrade, all required steps. Or alternatively, a script that does changes required to upgrade.
|
||||
- Using parts of frameworks as separate packages, like:
|
||||
- Authentication, like OAuth2, Gmail, etc
|
||||
- Option to not use websockets, because at some corporate networks do not allow them.
|
||||
- Option to not have Javascript at frontend, having SSR only. Working with and without Javascript at frontend, like ufront did.
|
||||
- https://github.com/ufront/ufront
|
||||
- https://jasono.co/2020/10/03/im-going-to-write-a-web-app-framework-again-maybe-well-see/
|
||||
- Please do not discontinue HTML (no Javascript) version https://news.ycombinator.com/item?id=37558372
|
||||
- Storing session to database, for round robin
|
||||
- https://github.com/wekan/wekan/issues/5120
|
||||
- https://stackoverflow.com/questions/65547266/how-to-store-my-session-mysql-with-express-mysql-session
|
||||
- Not having build step:
|
||||
- Keep all files at directories they currently are, with understandable directory structure naming, like:
|
||||
- Feature name
|
||||
- Feature part name 1
|
||||
- Feature part name 2
|
||||
- Only use file from it's location on page where it is needed
|
||||
- Cache dependencies. Make possible coding offline.
|
||||
- Do not uglify
|
||||
- https://world.hey.com/dhh/you-can-t-get-faster-than-no-build-7a44131c
|
||||
- Rails World Opening Keynote by DHH
|
||||
- https://www.youtube.com/watch?v=iqXjGiQ_D-A
|
||||
- https://news.ycombinator.com/item?id=37843951
|
||||
- https://news.ycombinator.com/item?id=37897921
|
||||
- I merged all branches to one main branch, because merging between branches did take a lot of time.
|
||||
- Do not use linters like eslint and prettier. What I did, is I removed all linters, like eslint, prettier etc, because they did disagree about syntax. Point is to make to code minimal change, that fixes something, or adds some feature. Not that most commits would be about fixing syntax.
|
||||
- https://matt-rickard.com/why-is-the-frontend-stack-so-complicated
|
||||
- https://news.ycombinator.com/item?id=37895164
|
||||
- https://deno.com/blog/node-config-hell
|
||||
- How to not become slow and unresponsive after a week https://github.com/wekan/wekan/issues/5140
|
||||
- Run code like CGI, release all memory
|
||||
- Looking for most cross-platform web frameworks, supporting many different CPU, OS and database.
|
||||
- Both On-Premise AND MultiCloud possible
|
||||
- https://github.com/serverless/multicloud
|
||||
- https://github.com/xet7/multicloud
|
||||
- License: MIT and other https://copyfree.org
|
||||
|
||||
## List of realtime web frameworks
|
||||
|
||||
- Meteor
|
||||
- https://www.meteor.com
|
||||
- https://github.com/meteor/meteor
|
||||
- Helene
|
||||
- Forum Post https://forums.meteor.com/t/helene-a-lightweight-real-time-web-framework-for-node-js-and-bun/60626
|
||||
- Repo https://github.com/leonardoventurini/helene
|
||||
- Discussions https://github.com/leonardoventurini/helene/discussions
|
||||
- NPM package https://www.npmjs.com/package/helene
|
||||
- Discord https://discord.com/invite/PbY36PU75C
|
||||
- Any others?
|
||||
|
||||
## Screenshot
|
||||
|
||||
Supporting many more webbrowsers:
|
||||
|
||||
<img src="https://wekan.fi/manybrowser.png" width="100%" alt="Multiverse WeKan screenshot" />
|
||||
|
||||
## Talks
|
||||
|
||||
- Maintainer of WeKan since December 2016, xet7 (Lauri Ojansivu), about WeKan Multiverse at EU NGI Dapsi https://www.youtube.com/watch?v=BPPjiZHVeyM
|
||||
- https://dapsi.ngi.eu/20-new-solutions-to-bring-the-power-of-data-back-to-peoples-hands/
|
||||
- https://dapsi.ngi.eu/hall-of-fame/multiverse/
|
||||
- WeKan Open Source kanban: add multiple Import/Export/Sync options and UI Designer, making it possible to create any app.
|
||||
|
||||
## Roadmap
|
||||
|
||||
From https://github.com/wekan/wekan/issues/4578#issuecomment-1407769397
|
||||
|
||||
## Standards
|
||||
|
||||
- Web Sustainability Guidelines (WSG) 1.0 at a Glance
|
||||
- https://w3c.github.io/sustyweb/glance.html
|
||||
- Minimize size, support all devices https://w3c.github.io/sustyweb/#benefits-90
|
||||
- Other standards? https://news.ycombinator.com/item?id=36675451
|
||||
|
||||
## Browsers developed for therapy reasons
|
||||
|
||||
Are you fed up? Need some therapy? Write a webbrowser!
|
||||
|
||||
- Gosub
|
||||
- https://adayinthelifeof.nl/2023/09/22/browsers.html
|
||||
- Repo https://github.com/jaytaph/gosub-browser
|
||||
- https://codemusings.nl/@jaytaph/p/MQpHToAx8c1KXyU98Auip4
|
||||
- https://news.ycombinator.com/item?id=37608580
|
||||
- Ladybird
|
||||
- https://www.ladybird.dev
|
||||
- Repo https://github.com/SerenityOS/serenity/tree/master/Ladybird
|
||||
|
||||
## Browsers that have Javascript
|
||||
|
||||
- Use Javascript to add drag-drop etc Javascript features, and hide UI elements like buttons etc that are for non-Javascript
|
||||
|
||||
## Browsers without using Websockets
|
||||
|
||||
- Maybe with long poll. Or no live update, require webpage reload.
|
||||
- For internal corporate networks where websockets are not allowed
|
||||
|
||||
## Browsers that do not support Javascript
|
||||
|
||||
or have Javascript disabled for security reasons.
|
||||
|
||||
- Netsurf https://www.netsurf-browser.org/downloads/ , Development Builds https://ci.netsurf-browser.org/builds/
|
||||
- RISC OS https://www.riscosopen.org/content/downloads , https://www.riscosdev.com/direct/
|
||||
- ReactOS https://reactos.org , https://github.com/howinfo/howinfo/wiki/ReactOS
|
||||
- Redox OS https://www.redox-os.org
|
||||
- Haiku, Linux, Windows, Amiga, Atari etc
|
||||
- Amiga: AWeb, iBrowse
|
||||
- Dillo Webbrowser at FreeDOS https://github.com/wekan/wekan/issues/4578#issuecomment-1248525591
|
||||
- Netscape, IE, etc all browsers at all OS/CPU
|
||||
- FreeDOS: Dillo, Arachne
|
||||
- Text based browsers: Lynx, Links, w3m (sudo apt-get install w3m w3m-img)
|
||||
- Ancient browsers:
|
||||
- http://9p.sdf.org/who/tweedy/ancient_browsers/
|
||||
- https://news.ycombinator.com/item?id=34981257
|
||||
|
||||
## Browsers that are programmable
|
||||
|
||||
- Nyxt
|
||||
- https://github.com/atlas-engineer/nyxt
|
||||
|
||||
## Support more databases
|
||||
|
||||
- SQLite
|
||||
- PostgreSQL
|
||||
- Migrations between databases
|
||||
- Using many databases at the same time
|
||||
- Offline or Local-First
|
||||
- https://news.ycombinator.com/item?id=37584049
|
||||
- https://news.ycombinator.com/item?id=37488034
|
||||
|
||||
## Graphics
|
||||
|
||||
- Raphael JS, supports also many legacy browsers, with VML and SVG graphics https://dmitrybaranovskiy.github.io/raphael/
|
||||
- Related forked repos for various graphics at https://github.com/raphaeljsorg
|
||||
- Or alternatively, just use HTML4, images, imagemaps etc to be compatible to non-Javascript browsers
|
||||
|
||||
## Programming language alternatives
|
||||
|
||||
- Optionally, use some transpiler:
|
||||
- https://en.wikipedia.org/wiki/Source-to-source_compiler
|
||||
- Haxe https://haxe.org , with HaxeUI [GUI/WebUI](http://haxeui.org/) and [TUI](https://github.com/haxeui/haxeui-pdcurses)
|
||||
- Wax https://github.com/xet7/wax
|
||||
- Nim https://nim-lang.org
|
||||
- V https://vlang.io
|
||||
- Maybe transpiling UI to/from HaxeUI XML, HTML4, HTML5, Gopher, Gemini, Lazarus, Gambas, Godot, MUI/ZUI Amiga/AROS
|
||||
|
||||
- Cross-platform:
|
||||
- C89 code for 30+ OS/CPU like at https://github.com/xet7/darkesthour
|
||||
- Pascal code with TRSE https://lemonspawn.com/turbo-rascal-syntax-error-expected-but-begin/
|
||||
- Embedded webserver, for example:
|
||||
- C https://github.com/wekan/hx/blob/main/prototypes/code/webserver/works/c/server.c
|
||||
- Sandstorm https://sandstorm.io , https://github.com/sandstorm-io/sandstorm
|
||||
- Rust https://github.com/dwrensha/sandstorm-rawapi-example-rust
|
||||
- C++ https://github.com/dwrensha/sandstorm-rawapi-example
|
||||
- Try to avoid strange NPM packages
|
||||
- https://marvinh.dev/blog/speeding-up-javascript-ecosystem-part-6/
|
||||
|
||||
## Benchmarks
|
||||
|
||||
- For selecting programming language:
|
||||
- https://github.com/wekan/hx/tree/main/prototypes/code/webserver
|
||||
- https://forums.meteor.com/t/performance-tests-between-meteor-3-meteor-2-help-on-format/60458
|
||||
- https://www.techempower.com/benchmarks/
|
||||
- https://github.com/TechEmpower/FrameworkBenchmarks/tree/master/frameworks
|
||||
|
||||
## Screenshot of Multiverse WeKan at FreeDOS Dillo
|
||||
|
||||
|
||||
|
||||
## Screenshot of Multiverse WeKan at Netsurf
|
||||
|
||||
### Group and count by first character of board names
|
||||
|
||||
From https://github.com/wekan/wekan/issues/4578#issuecomment-1250143726
|
||||
|
||||
When there is a lot of boards, it is very useful to group by first character of board (and after that click charater to see list of boards for that character, to be added later). I could not figure out how to do it with MongoDB aggregate query. Here is how I did it with SQLite, for type board. SQLite returns results immediately. Note that emojis, UTF-8 shows also on Netsurf browser. TODO is to figure out, could I get these visible also in FreeDOS Dillo browser.
|
||||
```
|
||||
SELECT _id, substr(title,1,1), COUNT(*), type from boards
|
||||
WHERE type=:type GROUP BY substr(title,1,1) ORDER BY substr(title,1,1) ASC;
|
||||
```
|
||||
Actually, somewhere I saved answer from ChatGPT or Bing AI search, what this SQL query using MongoDB Javascript syntax. So maybe I should ask again.
|
||||
|
||||
https://github.com/wekan/php/blob/main/page/allboardschar.php
|
||||
|
||||
|
||||
|
||||
## Prototypes
|
||||
|
||||
### Redbean
|
||||
|
||||
- Currently xet7 actively working with this prototype: https://github.com/wekan/wekanstudio
|
||||
- https://redbean.dev
|
||||
- Minimal kanban board drag drop example
|
||||
- Repo https://github.com/wekan/hx/tree/main/prototypes/code/webserver/works/fullmoon
|
||||
- Redbean amd64 binary works at Win/Mac/Linux/BSD/BIOS without any modifications, because it is based on Cosmopolitan https://github.com/jart/cosmopolitan
|
||||
- Uses HTMX https://htmx.org at UI
|
||||
- Saves to SQLite database
|
||||
- Petclinic fork, using Blink to run at s390x https://github.com/wekan/wekan/wiki/s390x#petclinic-s390x
|
||||
|
||||
### PHP
|
||||
|
||||
- Repo https://github.com/wekan/php
|
||||
- Features:
|
||||
- Some webpages compatible with all browsers
|
||||
- SQLite list all boards with first character, show board with some data
|
||||
- MongoDB test for newer MongoDB
|
||||
- upload file(s) with drag-drop, for upcoming feature https://github.com/wekan/wekan/issues/2936
|
||||
- RTL https://github.com/wekan/wekan/issues/3376#issuecomment-1243922087
|
||||
- Not yet: Login, Move card
|
||||
|
||||
### Gambas
|
||||
|
||||
- Repo https://github.com/wekan/hx/tree/main/prototypes/ui/gambas
|
||||
- Features: Login, dropdown menu structure, SQLite database
|
||||
- Not yet: Show board
|
||||
- Problems: Gambas login page etc requires Javascript, does not work in Netsurf
|
||||
|
||||
### Meteor SSR
|
||||
|
||||
- https://github.com/wekan/we
|
||||
- Features:
|
||||
- Only serverside rendering. Javascript removed removed from frontend.
|
||||
- Only test webpage. No actual features.
|
||||
|
||||
### Node.js 20, Bun and Deno
|
||||
- Repo https://github.com/wekan/ferretdb/tree/main/node-deno-bun
|
||||
- Features:
|
||||
- main.js makes database queries to many databases
|
||||
- Database drivers:
|
||||
- MongoDB driver for Legacy MongoDB 3.2.x, using MongoDB from `sudo snap install wekan`
|
||||
- MongoDB driver for newest MongoDB included, using MongoDB 6.x from rebuild-wekan.sh from https://github.com/wekan/wekan
|
||||
- FerretDB proxy to PostgreSQL, from docker-compose.yml
|
||||
- FerretDB proxy to SQLite, from docker-compose.yml
|
||||
- Bun size is about 93 MB
|
||||
- Deno size is usually about 350 MB https://github.com/wekan/wekan-node20/releases , but from source built Linux arm64 is 1.1 GB because of some bug somewhere.
|
||||
- Deno also includes Node.js as Deno's Node.js compatibility layer.
|
||||
- Node.js supports many CPU/OS
|
||||
- Node.js is used in production and has traceability. https://changelog.com/jsparty/294
|
||||
- https://github.com/wekan/wekan/wiki/s390x
|
||||
- https://nodejs.org/dist/latest-v20.x/
|
||||
- https://github.com/wekan/node-v14-esm/releases/tag/v14.21.4
|
||||
|
||||
### Haxe
|
||||
|
||||
- https://haxe.org
|
||||
- Hello world example
|
||||
- Repo https://github.com/wekan/hx/blob/main/prototypes/code/hello
|
||||
- Transpiled with Haxe to many programming languages
|
||||
- Tinkweb
|
||||
- Repo https://github.com/wekan/hx/tree/main/prototypes/ui/tinkweb
|
||||
- Has router and webpage
|
||||
- Transpiles to PHP and Node.js
|
||||
|
||||
### FreePascal
|
||||
|
||||
- Repo https://github.com/wekan/wami
|
||||
- Some static pages. At upload page, uploading file now works.
|
||||
- Previous:
|
||||
- Repo https://github.com/wekan/hx/tree/main/prototypes/code/webserver/works/freepascal-router
|
||||
- Router and some webpage
|
||||
- Works at many retro and modern OS, but not at s390x that FreePascal does not support yet https://wiki.freepascal.org/ZSeries
|
||||
|
||||
### FreeDOS and Bash
|
||||
|
||||
- Repo https://github.com/wekan/wedos
|
||||
- Features:
|
||||
- DOS: .bat script, that shows menu, and uses SQLite DOS version to make queries to WeKan SQLite database
|
||||
- Bash: .sh script, that shows menu, and uses SQLite CLI to make queris to WeKan SQLite database
|
||||
|
||||
### Minio
|
||||
|
||||
- Repo: https://github.com/wekan/minio-metadata
|
||||
- Features:
|
||||
- Uses Bash script and CLI binaries to migerate text data and attachments from MongoDB to SQLite and Minio
|
||||
- There is Node.js, Go etc drivers for using Minio
|
||||
|
||||
### CloudFlare Workers
|
||||
|
||||
- Developing
|
||||
- https://developers.cloudflare.com/pages/framework-guides/
|
||||
- https://developers.cloudflare.com/pages/
|
||||
- https://developers.cloudflare.com/workers/
|
||||
- https://developers.cloudflare.com/pages/platform/language-support-and-tools/
|
||||
- https://miniflare.dev
|
||||
- https://blog.cloudflare.com/workers-playground/
|
||||
- D1 SQLite
|
||||
- https://developers.cloudflare.com/d1/platform/community-projects/#d1-adapter-for-kysely-orm
|
||||
- https://blog.cloudflare.com/d1-open-beta-is-here/
|
||||
- https://blog.cloudflare.com/introducing-d1/
|
||||
- https://www.cloudflare.com/developer-platform/d1/
|
||||
- https://blog.cloudflare.com/hyperdrive-making-regional-databases-feel-distributed/
|
||||
- Northwind Traders example
|
||||
- https://northwind.d1sql.com
|
||||
- https://github.com/cloudflare/d1-northwind
|
||||
- https://github.com/xet7/d1-northwind
|
||||
- Kysely Query builder for D1 SQLite database
|
||||
- https://codedamn.com/news/product/dont-use-prisma
|
||||
- https://news.ycombinator.com/item?id=37804072
|
||||
- https://kysely.dev
|
||||
- https://github.com/kysely-org/kysely
|
||||
- https://www.npmjs.com/package/kysely
|
||||
- Awesome Kysely https://github.com/kysely-org/awesome-kysely
|
||||
- Older database examples: https://github.com/cloudflare/db-connect
|
||||
- Hono
|
||||
- https://blog.yusu.ke/hono-htmx-cloudflare/
|
||||
- https://news.ycombinator.com/item?id=37165054
|
||||
- https://github.com/yusukebe/hono-htmx
|
||||
- https://github.com/xet7/hono-htmx
|
||||
- https://developers.cloudflare.com/pages/framework-guides/
|
||||
- WebGPU
|
||||
- https://blog.cloudflare.com/webgpu-in-workers/
|
||||
- https://news.ycombinator.com/item?id=37673999
|
||||
- CloudFlare TV https://cloudflare.tv
|
||||
- CloudFlare https://cloudflare.com
|
||||
- TODO example with KV https://github.com/wekan/cloudflare-workers-todos
|
||||
|
||||
### Swap microframework, vs HTMX
|
||||
|
||||
- https://github.com/josephernest/Swap
|
||||
- https://news.ycombinator.com/item?id=35991783
|
||||
|
||||
### Ruby on Rails
|
||||
|
||||
- https://github.com/wekan/weror . Password register and login works, there is workspaces and dragging cards, but no user management etc features yet.
|
||||
Loading…
Add table
Add a link
Reference in a new issue