diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 122 |
1 files changed, 79 insertions, 43 deletions
@@ -1,9 +1,4 @@ -# Wekan - -[](https://transifex.com/wekan/wekan) - -[![Wekan Vanila Chat][vanila_badge]][vanila_chat] -[](http://webchat.freenode.net?channels=%23wekan&uio=d4) +# Wekan - Open Source kanban [](https://github.com/wekan/wekan/graphs/contributors) [](https://quay.io/repository/wekan/wekan) @@ -14,54 +9,85 @@ [](https://codeclimate.com/github/wekan/wekan) [](https://david-dm.org/wekan/wekan) [](https://www.openhub.net/p/wekan) +[](https://app.fossa.io/projects/git%2Bgithub.com%2Fwekan%2Fwekan?ref=badge_shield) -Please read [FAQ](https://github.com/wekan/wekan/wiki/FAQ). -Please don't feed the trolls and spammers that are mentioned in the FAQ :) +## [Translate Wekan at Transifex](https://transifex.com/wekan/wekan) -Wekan is an completely [Open Source][open_source] and [Free software][free_software] -collaborative kanban board application with MIT license. +Translations to non-English languages are accepted only at [Transifex](https://transifex.com/wekan/wekan) using webbrowser. +New English strings of new features can be added as PRs to edge branch file wekan/i18n/en.i18n.json . -Whether you’re maintaining a personal todo list, planning your holidays with -some friends, or working in a team on your next revolutionary idea, Kanban -boards are an unbeatable tool to keep your things organized. They give you a -visual overview of the current state of your project, and make you productive by -allowing you to focus on the few items that matter the most. +## [Wekan feature requests and bugs](https://github.com/wekan/wekan/issues) -Wekan has real-time user interface. Not all features are implemented. +Please add most of your questions as GitHub issue: [Wekan feature requests and bugs](https://github.com/wekan/wekan/issues). +It's better than at chat where details get lost when chat scrolls up. -[Features][features] +## Chat -Wekan supports many [Platforms][platforms], and plan is to add more. +[![Wekan Chat][vanila_badge]][wekan_chat] - Most Wekan community and developers are here. Works on webbrowser +and PWA app that can be added as icon on Android and bookmark on iOS, used like native app. -[Integrations][integrations] +[Wekan IRC FAQ](https://github.com/wekan/wekan/wiki/IRC-FAQ) -[Team](https://github.com/wekan/wekan/wiki/Team) +## FAQ -You don’t have to trust us with your data and can install Wekan on your own -computer or server. In fact we encourage you to do that by providing -one-click installation on various platforms. +**NOTE**: +- Please read the [FAQ](https://github.com/wekan/wekan/wiki/FAQ) first +- Please don't feed the trolls and spammers that are mentioned in the FAQ :) -## Roadmap +## About Wekan + +Wekan is an completely [Open Source][open_source] and [Free software][free_software] +collaborative kanban board application with MIT license. -[Roadmap](https://github.com/wekan/wekan/wiki/Roadmap) +Whether you’re maintaining a personal todo list, planning your holidays with some friends, +or working in a team on your next revolutionary idea, Kanban boards are an unbeatable tool +to keep your things organized. They give you a visual overview of the current state of your project, +and make you productive by allowing you to focus on the few items that matter the most. -Upcoming Wekan App Development Platform will make possible -many use cases. If you don't find your feature or integration in -GitHub issues and [Features][features] or [Integrations][integrations] -page at wiki, please add them. +Since Wekan is a free software, you don’t have to trust us with your data and can +install Wekan on your own computer or server. In fact we encourage you to do +that by providing one-click installation on various platforms. -We are very welcoming to new developers and teams to submit new pull -requests to devel branch to make this Wekan App Development Platform possible -faster. Please see [Developer Documentation][dev_docs] to get started. -We also welcome sponsors for features, although we don't have any yet. -By working directly with Wekan you get the benefit of active maintenance -and new features added by growing Wekan developer community. +- Wekan is used in [most countries of the world](https://snapcraft.io/wekan). +- Wekan largest user has 13k users using Wekan in their company. +- Wekan has been [translated](https://transifex.com/wekan/wekan) to about 50 languages. +- [Features][features]: Wekan has real-time user interface. +- [Platforms][platforms]: Wekan supports many platforms. + Wekan is critical part of new platforms Wekan is currently being integrated to. +- [Integrations][integrations]: Current possible integrations and future plans. + +## Requirements + +- 64bit: Linux [Snap](https://github.com/wekan/wekan-snap/wiki/Install) or [Sandstorm](https://sandstorm.io) / + [Mac](https://github.com/wekan/wekan/wiki/Mac) / [Windows](https://github.com/wekan/wekan/wiki/Install-Wekan-from-source-on-Windows). + [More Platforms](https://github.com/wekan/wekan/wiki/Platforms). [ARM progress](https://github.com/wekan/wekan/issues/1053#issuecomment-410919264). +- 1 GB RAM minimum free for Wekan. Production server should have miminum total 4 GB RAM. + For thousands of users, for example with [Docker](https://github.com/wekan/wekan/blob/devel/docker-compose.yml): 3 frontend servers, + each having 2 CPU and 2 wekan-app containers. One backend wekan-db server with many CPUs. +- Enough disk space and alerts about low disk space. If you run out disk space, MongoDB database gets corrupted. +- SECURITY: Updating to newest Wekan version very often. Please check you do not have automatic updates of Sandstorm or Snap turned off. + Old versions have security issues because of old versions Node.js etc. Only newest Wekan is supported. + Wekan on Sandstorm is not usually affected by any Standalone Wekan (Snap/Docker/Source) security issues. +- [Reporting all new bugs immediately](https://github.com/wekan/wekan/issues). + New features and fixes are added to Wekan [many times a day](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md). +- [Backups](https://github.com/wekan/wekan/wiki/Backup) of Wekan database once a day miminum. + Bugs, updates, users deleting list or card, harddrive full, harddrive crash etc can eat your data. There is no undo yet. + Some bug can cause Wekan board to not load at all, requiring manual fixing of database content. -Actual work happens at [Wekan GitHub issues][wekan_issues]. +## Roadmap -See [Development links on Wekan -wiki](https://github.com/wekan/wekan/wiki#Development) -bottom of the page for more info. +[Roadmap Milestones](https://github.com/wekan/wekan/milestones) + +[Developer Documentation][dev_docs] + +- There is many companies and individuals contributing code to Wekan, to add features and bugfixes + [many times a day](https://github.com/wekan/wekan/blob/devel/CHANGELOG.md). +- [Please add Add new Feature Requests and Bug Reports immediately](https://github.com/wekan/wekan/issues). +- [Commercial Support](https://wekan.team). +- [Bounties](https://wekan.team/bounties/index.html). + +We also welcome sponsors for features and bugfixes. +By working directly with Wekan you get the benefit of active maintenance and new features added by growing Wekan developer community. ## Demo @@ -73,9 +99,16 @@ bottom of the page for more info. [![Screenshot of Wekan][screenshot_wefork]][roadmap_wefork] -Since Wekan is a free software, you don’t have to trust us with your data and can -install Wekan on your own computer or server. In fact we encourage you to do -that by providing one-click installation on various platforms. +## Stable + +- master+devel branch. At release, devel is merged to master. +- Receives fixes and features that have been tested at edge that they work. +- If you want automatic updates, [use Snap](https://github.com/wekan/wekan-snap/wiki/Install). +- If you want to test before update, [use Docker quay.io release tags](https://github.com/wekan/wekan/wiki/Docker). + +## Edge + +- edge branch. All new fixes and features are added to here first. [Testing Edge](https://github.com/wekan/wekan-snap/wiki/Snap-Developer-Docs). ## License @@ -100,4 +133,7 @@ with [Meteor](https://www.meteor.com). [open_source]: https://en.wikipedia.org/wiki/Open-source_software [free_software]: https://en.wikipedia.org/wiki/Free_software [vanila_badge]: https://vanila.io/img/join-chat-button2.png -[vanila_chat]: https://chat.vanila.io/channel/wekan +[wekan_chat]: https://community.vanila.io/wekan + + +[](https://app.fossa.io/projects/git%2Bgithub.com%2Fwekan%2Fwekan?ref=badge_large)
\ No newline at end of file |