Skip to main content
Help us improve Python packaging – donate today!

Misago is modern, fully featured forum application written in Python and ES6, powered by Django and React.js. It works out of the box and plays nicely with other projects like Django-CMS.

Project Description

Tests Result Test Coverage Development Chat Works on Python 2.7, 3.5, 3,6

Development Status: 🍌 Bananas 🍌

Misago aims to be complete, featured and modern forum solution that has no fear to say ‘NO’ to common and outdated opinions about how forum software should be made and what it should do.

Screenshots

Forum index Thread view

Production use

As of now Misago implements all features considered “must have” on live internet forum:

  • Your users may register accounts, set avatars, change options and edit their profiles. They have option to reset forgotten password.
  • Site admins may require users to confirm validity of their e-mail addresses via e-mail sent activation link, or limit user account activation to administrator action. They can use custom Q&A challenge, ReCAPTCHA, Stop Forum Spam or IP’s blacklist to combat spam registrations. Pletora of settings are available to control user account behaviour, like username lengths or avatar restrictions.
  • Create categories together with unlimited number and depth of subcategories.
  • Write messages using either GitHub flavoured markdown, BBCode subset, or both.
  • Presence features let site members know when other users are online, offline or banned. Individual users have setting to hide their activity from non-admins.
  • Complete moderation toolset allowing admin-approved moderators to edit, move, hide, approve, delete or close user posted content. This also includes option to delete or block user accounts or avatars.
  • Ban system allows you to ban existing users as well as forbid certain user names, e-mails or IP addresses from registering accounts.
  • Permission system allowing you to control which features are available to users based on their rank, roles or category they are in.
  • Private threads feature allowing users to create threads visible only to them and those they’ve invited.
  • Python-based profile fields framework letting site owners to define custom fields for users to fill in complete with powerful customization options for custom requirements, display or validation logic.
  • Rich polls system, allowing polls with public and private voters, single and multiple choices as well as ones that allow vote change or limit voting tp limited period of time.
  • Post attachments complete thumbnailing and gif’s animation removal.
  • Mark post in question thread as best answer, bringing basic Q&A functionality.
  • Posts edits log allowing you to see how user messages used to look in past as well as revert function protecting you from malignant users emptying their posts contents.
  • Moderation queue for users and categories allowing you to moderate content before it becomes visible to other members of the community.
  • Custom theme developed over bootstrap.
  • Optionally enable users to delete their own account.
  • Anonymise user data on their account’s deletion.

Even more features will follow in future releases:

  • Achievements and awards system.
  • Content reporting for users to report offensive content.
  • Forum-wide JS routing further reducing navigation times.
  • IP search for moderators to find sock puppets or bot nets.
  • Notifications for users to notice content and events of concern faster.
  • Post accurate read tracker that lets moderators spot unapproved replies and non-moderators spot approved posts.
  • Sign in with Facebook/Google/Github/Steam/etc/ect.
  • Warning system for easy tracking users history of infractions and offenses.
  • WYSIWYM content editor for even easier post formatting.

If you are looking into using Misago to run live forum, you are absolutely invited to, but please keep in mind that Misago is relatively immature software that may contain serious bugs or issues as well as quirks and lackings thay may take time to resolve, despite best efforts.

Development

To start Misago site locally, first make sure you have Docker installed.

Next, clone repository on your machine and run following commands:

docker-compose build
docker-compose run --rm misago initdev
docker-compose up

Those commands will install necessary dependencies, create new Misago project devproject that you may use for development as well as start Django developer server, enabling you to visit 127.0.0.1:8000 in your browser and see the forum index. You should now be able to sign in with the superuser account, using Admin username and password password.

Admin Control Panel is available under the 127.0.0.1:8000/admincp/ url.

manage.py is available through Docker’s run command:

docker-compose run --rm misago python manage.py

Docker also allows you to run tests suite:

docker-compose run --rm misago python runtests.py

If you’ll ever want to destroy Docker setup because you no longer need it, run this command:

docker-compose down

Frontend

With exception of Admin Panel, Misago frontend relies heavily on React.js components backed by Django API. This application relies on custom Gulp.js-based toolkit for development. As of current, Misago’s gulpfile.js defines following tasks:

  • build does production build of Misago’s assets, concating and minifying javascripts, css and images, as well as moving them to misago/static directory
  • watch does quick build for assets (concat assets into single files, compile less, deploy to misago/static but don’t minify/optimize) as well as runs re-build when less/js changes
  • watchstyle does quick build of less files, and re-builds them when they change
  • test runs Mocha.js tests suite for Misago’s javascript

To start work on custom frontend for Misago, fork and install it locally to have development forum setup. You can now develop custom theme by modifing assets in frontend directory, however special care should be taken when changing source javascripts.

Misago defines template that allows you to include custom html and js code before Misago’s JavaScript app is ran, named scripts.html.

Bug reports, features and feedback

If you have found bug, please report it on issue tracker.

For feature or support requests as well as general feedback please use official forum instead. Your feedback means much to the project so please do share your thoughts!

There’s also Gitter for those looking for intant-messaging approach for discussing Misago development.

Contributing

If you have corrected spelling, wrote new tests or fixed a bug, feel free to open pull request.

Many issues are open for takers. If you’ve found one you feel you could take care of, please announce your intent in issue discussion before you start working. That way situations when more than one person works on solving same issue can be avoided.

Authors

Rafał Pitoń

English sentences used within misago.faker.phrases were extracted from National Aeronautics and Space Administration Solar System Exploration Portal and are not copyrighted as per Media and content usage guidelines.

Release history Release notifications

This version
History Node

0.17.3

History Node

0.17.2

History Node

0.17.0b1

History Node

0.16.0

History Node

0.15.0

History Node

0.14.0

History Node

0.13.0

History Node

0.12.0

History Node

0.11.0

History Node

0.10.0

History Node

0.10.0a1

History Node

0.9.0

History Node

0.8.0

History Node

0.7.1

History Node

0.7.0

History Node

0.7.0a1

History Node

0.6.0

History Node

0.6a11

History Node

0.6a10

History Node

0.6a9

History Node

0.6a8

History Node

0.6a7

History Node

0.6a6

History Node

0.6a5

History Node

0.6a4

History Node

0.6a3

History Node

0.6a2

History Node

0.6a1

History Node

0.6a1.dev3

History Node

0.6a1.dev2

History Node

0.6.0dev

History Node

0.5.5a1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
Misago-0.17.3.tar.gz (8.1 MB) Copy SHA256 hash SHA256 Source None Apr 2, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page