Repository navigation
Developer Documentation
We follow the meteor style guide.
Please read the meteor style guide before making any significant contribution.
There is find.sh script that ignores generated directories, finds code in subdirectories, and paginates with less. For example, finding how search cards is implemented:
cd wekan
./find.sh js-search
When you run this, you see .jade template files where is search input box, and .js files where is the search code. CSS is in .styl files.
- Currently Wekan development is done mainly at Ubuntu 16.04 64bit, but building Wekan does work on any Debian 9 64bit or Ubuntu 14.04 64bit or newer.
- Install Wekan from source with rebuild-wekan.sh script, with options 1 to install dependencies and 2 to rebuild source, to your Linux computer (Debian 9 or Ubuntu 14.04 or newer), or try installing it via the virtual appliance
- You can use for example Visual Studio Code for editing code, it has Meteor.js etc plugins
- When changing database schema, migrations can be used.
- Excellent example how pull requests are improved and integrated, and not needed commits removed
- Ask questions at
- We used to be at
Rocket.Chatbut that's been discontinued.
- We used to be at
- You can ask anything, we are here to help. But also consult the sources that are already available.
- Look through old pull requests
- Read Wekan source code, you can use some git history viewer GUI like gitk
- Read Meteor documentation for Meteor version in use, other versions mentioned at Dockerfile
- Docker up-to-date way: You can clone wekan/wekan repo and update docker-compose.yml file ROOT_URL etc as documented at https://github.com/wekan/wekan-mongodb commented docker-compose.yml file, install docker, and build from source with docker with "docker-compose up -d --build"
- Docker not up-to-date way: Docker environment for Wekan development.
- If package is available on meteor https://atmospherejs.com
meteor add packagenameor https://www.npmjs.commeteor npm install packagenamethen it's enough to add package that way, and there is no need to clone repo in rebuild-wekan.sh script. - When doing pull requests, only add additions and changes to English at wekan/i18n/en.i18n.json . Other translations are done at https://www.transifex.com/wekan/wekan.
- If you have fix to some existing pull request, add your fix as comment. Do not post new pull request.
- For new features add new pull request, if there is none already.
- remove all console.log statements
- Fix all lint errors and warnings
- Add Snap settings to code so that feature is default disabled, and can be enabled with Snap commands
- Add Snap settings to wiki
- Add settings also to Dockerfile
- Make your pull request to edge branch.
- Use the feature branch workflow.
- create a PR from your feature-branch to
wekan/edgedirectly so that you can continue your work without interruption.
- create a PR from your feature-branch to
- Keep your local forks updated with this repo by setting your
git upstreamvalue as described here.- before submitting a PR make sure you
rebaseyour local branch as described here - If you accidentally mess around on your
edgebranch, follow these steps here to clean it up. Note: currently there is only master branch, not devel or edge branches. - Here is how to remove commits from pull request
- before submitting a PR make sure you
- NOTE: Travis is currently broken and always shows warnings and errors like variables not defined or not used, so if your code works, ignore Travis.
- Eslint for linting. To prevent Travis CI lint errors, you can test for lint errors by installing
npm install eslintand running it withnpm run lintand trying automatic fixing witheslint --fix filename.js - There is also probably not-currently-working as of 2018-05-05 jsbeautifer website with settings Indent with 2 spaces (topmost dropdown), [X] Space before conditional: "if(x)" / "if (x)", [X] Use JSLint-happy formatting tweaks.
- You are free to select what feature to work on.
- Leave a comment on an issue saying that you're working on it, and give updates as needed.
- Work and concentrate on one issue at a time and finish it, before moving to other issue.
- Keep list of your contributions on your personal website.
- Keep track of time it takes to implement each part of a feature, so you can estimate what time it would take to implement similar feature. After implementing feature, review your estimate was it correct, make improvements to your process and estimates, also keeping enough time allocated in estimate if something is harder to implement. Employers look for coders with proven track record.
- You can ask for comments from others, but usually those feature requests are clearly defined how they should work. You can place those Settings options there where it seems most logical for you.
Main point is to be friendly to those commenting of your code, and incorporate those suggestions that make most sense.
- Templates are written in JADE instead of plain HTML. Also see HTML to JADE converter.
- CSS is written in the Stylus precompiler - see Stylus to CSS converter, and
- Meteor templates are created as BlazeLayout templates.
- Instead of the allow/deny paradigm a lot of the
collectionsdefined in the project usemutationsto define what kinds of operations are allowed.
For further details look for the 'feature summaries' in the Wiki (still in progress) otherwise go through the git history and see how old features were built. Might I suggest the Start and Due date feature wefork#26
If adding new features, please also support the internationalization features built in. Refer to the Translations wiki page.
It's possible to import your existing boards from Trello. Instructions here
Wekan - OpenSource Kanban
- 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
- NOT related to Wekan
- Wekan vs Trello vs Restyaboard
- Results of Survey 2020-01
- Allow private boards only: Disable Public Boards
- Security Disclosure and details of Security in Wekan
- Security issues
- Password Hashing
- 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
- Progress: Import/Export/Sync
- From CSV/TSV
- From Trello
- From Jira
- From Asana
- From Zenkit
- From old Wekan manually
- Converting Meteor Stylus to CSS
- Repair MongoDB
- Using Meteor MongoDB to repair files
- If board does not open and keeps loading
- Repair Docker
- Wekan Markdown
- Emoji
- Mermaid Diagram DOES NOT WORK ANYMORE
- Numbered text
- Automatic 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
- Nextcloud
- CAS Please test
- SAML Please test
- 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
- Download Wekan for various Platforms: Supported by xet7, Operating Systems, NAS, Cloud
- Helm Chart for Kubernetes
- Caddy
- Nginx
- Apache
- OpenLiteSpeed
- Local self signed TLS
- Let's Encrypt and Google Auth
- TLS with Node.js
- Traefik and self-signed SSL certs
- 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
- 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
