22 Design Principles

Lauri Ojansivu edited this page 2025-03-08 19:36:16 +02:00

Table of Contents

• WeKan Design Principles

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.github.io/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

Wekan

General

• Deep Dive Into WeKan
• Meteor WeKan Roadmap - board at Wekan demo
• Multiverse WeKan Roadmap
• Docs/Manual
• Change Language
• Forgot Password
• About
• Test Edge
• WeKan Design Principles
• FAQ
• IRC FAQ - answers to questions asked at IRC
• Team
• Press
• Blog
• Wekan vs Trello vs Restyaboard
• Results of Survey 2020-01

Fake: Not WeKan kanban

• Hall of Shame: Fake companies that are NOT WeKan kanban
• Others NOT related to WeKan kanban

Security

• Allow private boards only: Disable Public Boards
• Security Disclosure and details of Security in Wekan
• Security issues
• Password Hashing

Scaling

• Cron: Hourly restart WeKan, because of memory leaks
• Maybe: Add more RAM to Node.js to prevent crash
• Clustering AWS etc
• Scaling
• Kubernetes
• Redis Oplog
• Meteor Scaling at Meteor Cloud
• Scaling at Meteor forums

Migrating

• From Previous Export, paste big WeKan JSON
• Progress: Import/Export/Sync
• From CSV/TSV
• From Trello
• From Jira
• From Asana
• From Zenkit
• From old Wekan manually
• Converting Meteor Stylus to CSS

Support priorities for new features and bugfixes

1. Commercial Support
2. Community Support
3. Debugging

Backup

• Backup and Restore

Repair

• Repair MongoDB
• Using Meteor MongoDB to repair files
• If board does not open and keeps loading
• Repair Docker

Themes

• Themes
• Dark Mode

Markdown Syntax

• Wekan Markdown
• Emoji
• Mermaid Diagram DOES NOT WORK ANYMORE
• Numbered text

Login Auth

• Automatic login
• Disable Password Login
• Forgot Password
• Admin: Impersonate user
• Adding Users
• Active users Presence
• Accounts Lockout: Brute force login protection
• LDAP
• LDAP AD Simple Auth
• Keycloak
• Google login
• Azure
• OAuth2, Auth0, GitLab, RocketChat
• Oracle OIM on premise using OAuth2
• ADFS 4.0 using OAuth2 and OpenID
• Azure AD B2C using OAuth2
• Nextcloud
• CAS Please test
• SAML Please test
• Zitadel

Metrics, Logs, Stats

• Metrics
• Logs
• Stats

Integrations

• IFTTT
• n8n Wekan docs - n8n GitHub
• Integrations
• Gogs

Time

• Time Tracking
• Gantt Chart
• Due Date
• Day of week start
• Calendar

Features

• Multiline
• Linked Cards
• Drag Drop on Mobile and Desktop
• Rclone: Store attachments to cloud storage like S3, MinIO, etc
• Python based features
• Burndown and Velocity Chart
• Wait Spinners
• Translations
• Default Language for All Users
• Roadmap
• Features
• Planning Poker
• Scaling
• Custom Logo
• Subtasks <== Has fix
• Templates
• Cover
• Archive and Delete
• Custom Fields
• Fix Export board menu not visible on some boards
• RAM usage
• Demo
• Swimlane Documentation
• Customize Translations

Email

• Email

Required Settings

• Requirements
• Ports, hostsfile, how Internet works
• ROOT_URL Settings

Download

• Download Wekan for various Platforms: Supported by xet7, Operating Systems, NAS, Cloud
• Helm Chart for Kubernetes

Webservers

• Caddy
• Nginx
• Apache
• OpenLiteSpeed
• Local self signed TLS
• Let's Encrypt and Google Auth
• TLS with Node.js
• Traefik and self-signed SSL certs

REST API Docs

• REST API Code
• Login
• User
• Role
• Boards
• Lists
• Cards
• Checklists
• Swimlanes
• Custom Fields
• Integrations

REST API issue

• REST API Issue

REST API client code

• Example: New card with Python3 and REST API
• Python client to REST API
• Go client to REST API
• Java
• Wekan Sandstorm cards to CSV using Python
• Excel and VBA

Webhooks

• Global Webhook
• Limiting Webhook data
• Receiving Webhooks
• Outgoing Webhook to Discord/Slack/RocketChat/Riot
• Outgoing Webhook to NodeRed
• Outgoing Webhook to PowerShell
• Security: Webhook and CA
• Outgoing Webhooks Data
• Outgoing Webhooks and Let's Encrypt
• Outgoing Webhooks Original Pull Request, multiple Webhooks, more parameters and response order

Case Studies

• Implementing GDPR

Development

• Kadira integration
• Debugging
• Developer Docs for Standalone Wekan
• Developer Docs for Sandstorm Wekan
• Adding new Snap setting to code
• Directory Structure
• Building Wekan for Sandstorm
• Docs - Sandstorm etc
• Beginner
• Maintainer FAQ

Issues

• Bugs
• Feature requests
• Import / Export
• Drag and Drop
• Accessibility
• Navigation:Keyboard
• Targets:Mobile-web
• REST API
• Admin Panel
• Encryption
• Permissions
• Logs
• Notifications
• Filters
• Checklists
• Swimlanes
• LibreJS
• Markdown

Wekan - OpenSource Kanban