Differences between revisions 16 and 36 (spanning 20 versions)
Revision 16 as of 2012-09-05 08:05:20
Size: 3009
Editor: mindlace
Comment: Changed instructions to not require root access
Revision 36 as of 2018-04-20 06:16:05
Size: 180
Editor: maxking
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#pragma page-filename DEV/versions/15171649
This is a quick guide to setup a development environment to work on Postorius, Mailman 3's web ui. 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.
#pragma page-filename DEV/versions/13303871
Line 4: Line 3:
In order to download the components necessary you need to have the Bazaar VCS installed on your system. Mailman and mailman.client need at least Python version 2.6. {{{#!wiki warning
'''This guide is obsolete! See [[http://docs.mailman3.org/en/latest/devsetup.html]] to setup mailman3.'''
Line 6: Line 6:
== Set up your environment with virtualenv ==

If you're not already set up to develop with virtualenv, you should do so:

{{{{#!table
'''Ubuntu'''
|| '''OS X'''
==
{{{$ sudo apt-get install python-setuptools python-dev build-essential}}}

|| {{{
$ brew install python

$ echo "export PATH=/usr/local/share/python:$PATH" >> ~/.bash_profile
$ source ~/.bash_profile
$ pip install distribute }}}
}}}}

You're almost there - just get virtualenv:

{{{$ pip install virtualenv}}}

{{{#!wiki important

You may wish to install [[http://virtualenvwrapper.readthedocs.org/en/latest/index.html|Virtualenvwrapper]] as well for managing your environment with ease.
Line 32: Line 7:

For the remaining bit, we're going to assume your virtual environment is called "postorius". You would initialize and activate it as follows:

{{{{#!table
'''virtualenv only'''
|| '''with virtualenvwrapper'''
==
{{{$ virtualenv postorius}}}
{{{$ source postorius/bin/activate}}}

|| {{{$ mkvirtualenv postorius}}}
}}}}

Now you should see (postorius) before your prompt.

== 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}}}

== Install Django ==

{{{
(postorius)$ pip install django
(postorius)$ pip install django-social-auth}}}

== Get everything set up ==

=== GNU Mailman 3 ===

Install and test:

{{{
(postorius)$ cd mailman 
(postorius)$ python bootstrap.py
(postorius)$ bin/buildout
(postorius)$ bin/test
}}}

If you get no errors you can now start Mailman:

{{{
(postorius)$ bin/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
}}}

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 http://docs.mailman3.org/en/latest/devsetup.html 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)