Differences between revisions 34 and 35
Revision 34 as of 2017-02-19 08:40:35
Size: 2597
Editor: terri
Comment: Link to the most up to date guide on this wiki
Revision 35 as of 2017-05-23 22:11:51
Size: 155
Editor: ScottKarlin
Comment:
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
This is a quick guide to setup a development environment to work on [[DEV/Web Interface|Postorius, Mailman 3's web UI]] (and, in the process, install the core Mailman engine and Mailman.client as well). If all goes as planned, you should be done within ~5 minutes. This has been tested on Ubuntu 11.04 and OS X 10.8.1.  Please note that the Python provided by apple for OSX ''will not work''; you need to install your own version of python (e.g. using fink or macports). The [[../Mac Mailman development setup guide|Mac Mailman development setup guide]] has instructions using homebrew if you need additional instructions.

Also, this 5-minute guide will not help you install HyperKitty, the web-based list archiver; for that, see [[HyperKitty/DevelopmentSetupGuide|this guide]].

== Set up your environment ==

Install the essentials

{{{$ sudo apt-get install bzr python-dev python-virtualenv build-essential postfix}}}

Set up a virtual environment (here we're calling it "postorius").

Get the sources

{{{
(postorius)$ bzr branch lp:mailman
(postorius)$ bzr branch lp:mailman.client
(postorius)$ bzr branch lp:postorius
(postorius)$ bzr branch lp:~mailman-coders/postorius/postorius_standalone}}}

If you get permission errors on this step, your ssh key is probably not in sync with what is on launchpad.net.


== Set up sources ==

=== GNU Mailman 3 ===

{{{
(postorius)$ cd mailman 
(postorius)$ python setup.py install}}}

If you get no errors you can now start Mailman:

{{{
(postorius)$ mailman start
(postorius)$ cd ..
}}}

At this point Mailman will not send nor receive any real emails. But that's fine as long as you only want to work on the components related to the ReST client or the web ui.

=== mailman.client (the Python bindings for Mailman's ReST API) ===

{{{
(postorius)$ cd mailman.client
(postorius)$ python setup.py develop
(postorius)$ cd ..}}}

=== Postorius ===

{{{
(postorius)$ cd postorius
(postorius)$ python setup.py develop
(postorius)$ cd ..}}}

== Start the development server ==

{{{
(postorius)$ cd postorius_standalone
(postorius)$ python manage.py syncdb
(postorius)$ python manage.py runserver
}}}

== Profit! ==

Now go to [[http://localhost:8000|http://localhost:8000]] to see the web UI for mailman!
----

 * [[DEV/Mac Mailman development setup guide|Mac Mailman development setup guide]]

----

<<IncludeComments>>

This guide is obsolete! See DEV/SetupDevEnvironment to setup mailman3.

MailmanWiki: DEV/A 5 minute guide to get the Mailman web UI running (last edited 2018-04-20 06:16:05 by maxking)