README.rst 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. ================================
  2. django Organice |latest-version|
  3. ================================
  4. |travis-ci| |health| |downloads| |license|
  5. All-in-one collaboration solution. For non-profit organizations, sports clubs, small to
  6. medium-sized businesses.
  7. django Organice is a nice way to run a collaboration platform, an intranet, and websites for your
  8. business. It's a compilation of the best Django packages, preconfigured for getting you started
  9. quickly. Being powered by the well-known `Django Web framework`_ it's a safe choice for your IT
  10. investment providing an easily extensible architecture.
  11. .. |latest-version| image:: https://img.shields.io/pypi/v/django-organice.svg
  12. :alt: Latest version on PyPI
  13. :target: https://pypi.python.org/pypi/django-organice
  14. .. |travis-ci| image:: https://travis-ci.org/Organice/django-organice.svg
  15. :alt: Build status
  16. :target: https://travis-ci.org/Organice/django-organice
  17. .. |health| image:: https://landscape.io/github/Organice/django-organice/master/landscape.svg?style=flat
  18. :target: https://landscape.io/github/Organice/django-organice/master
  19. :alt: Code health
  20. .. |downloads| image:: https://img.shields.io/pypi/dm/django-organice.svg
  21. :alt: Monthly downloads from PyPI
  22. :target: https://pypi.python.org/pypi/django-organice
  23. .. |license| image:: https://img.shields.io/pypi/l/django-organice.svg
  24. :alt: Software license
  25. :target: https://www.apache.org/licenses/LICENSE-2.0.html
  26. .. _Django Web framework: https://www.djangoproject.com/
  27. Fundamental Features
  28. ====================
  29. - Enables everyone to contribute to your content---while retaining your full control.
  30. - Supports all four common collaboration and support patterns in several ways:
  31. #. *Active contribution* (create content, contribute corrections)
  32. #. *Passive contribution* (report issues, assign tasks, provide feedback)
  33. #. *Active consumption* (search and browse for content)
  34. #. *Passive consumption* (subscribe to notifications)
  35. - Continually involves, helps and optimally supports your collaborators by sending out reminders,
  36. editing and submission hints to avoid losing traction or interest.
  37. Core Components
  38. ===============
  39. Major components of django Organice are:
  40. - Django Web framework
  41. - full-featured content management (django CMS)
  42. - full-featured versatile blog (Zinnia, cmsplugin)
  43. - events with event calendar (via Zinnia)
  44. - flexible contact pages (cmsplugin)
  45. - link collection pages
  46. - full-featured newsletter (Emencia)
  47. - todo/issue lists
  48. - social login and user profiles (allauth)
  49. - generic analytics support (analytical)
  50. - web analytics respecting your privacy (Piwik integration)
  51. - multiple themes (available for free at http://organice.io/themes)
  52. - multi-language support
  53. - multiple websites support
  54. - database support for PostgreSQL, MySQL, Oracle, and more
  55. Roadmap
  56. =======
  57. We are thrilled to get these awesome features out to you:
  58. - group spaces with automatic mailing list (groupname@example.com)
  59. - documentation area / wiki (probably by use of CMS functionality)
  60. - discussion forum / Q&A board (Askbot, Misago)
  61. - content download for magazine generation
  62. - unobtrusive, integrated, transparent document and asset management
  63. - DropBox, ownCloud, Windows OneDrive, Google Drive, Apple iCloud, etc. integration
  64. - fully integrated search (Haystack)
  65. - live chat or chat integration
  66. - surveys (django-crowdsourcing, ntusurvey)
  67. Who is using django Organice?
  68. =============================
  69. Examples of websites running django Organice:
  70. - `Organice.io website <http://organice.io/>`_
  71. - `Organice demo site <http://demo.organice.io/>`_
  72. - `Kreuzlingen Rudolf Steiner school <http://www.rssk.ch/>`_
  73. Download and Contributions
  74. ==========================
  75. Official repositories: (kept in sync)
  76. #. Bitbucket: https://bitbucket.org/organice/django-organice
  77. #. GitHub: https://github.com/organice/django-organice
  78. Getting Help
  79. ============
  80. - Documentation is available at http://docs.organice.io
  81. - Questions? Please use `StackOverflow`_. Tag your questions with ``django-organice``.
  82. - Found a bug? Please use either the `Bitbucket`_ or `GitHub`_ issue tracker (you choose)
  83. .. _StackOverflow: http://stackoverflow.com/questions/tagged/django-organice
  84. .. _Bitbucket: https://bitbucket.org/organice/django-organice/issues
  85. .. _GitHub: https://github.com/organice/django-organice/issues