Differences between revisions 19 and 36 (spanning 17 versions)
Revision 19 as of 2012-09-05 08:58:46
Size: 3524
Editor: mindlace
Comment:
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/15171655
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:
== Set up your environment == {{{#!wiki warning
'''This guide is obsolete! See [[http://docs.mailman3.org/en/latest/devsetup.html]] to setup mailman3.'''
Line 6: Line 6:
Install the essentials

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

{{{
$ ruby <(curl -fsSkL raw.github.com/mxcl/homebrew/go)
$ brew install python
$ echo "export PATH=/usr/local/share/python:$PATH" >> ~/.bash_profile
$ source ~/.bash_profile
$ brew install bazaar
$ pip install distribute}}}

Install virtualenv and virtualenvwrapper:

{{{
$ pip install virtualenv
$ pip install virtualenvwrapper
$ echo "export WORKON_HOME=$HOME/.virtualenvs" >> ~/.bash_profile
$ echo "source `which virtualenvwrapper.sh`" >> ~/.bash_profile
$ export WORKON_HOME=$HOME/.virtualenvs
$ source virtualenvwrapper.sh }}}

Create the postorious virtual environment:

{{{
$ mkvirtualenv postorius
New python executable in postorius/bin/python
Installing setuptools............done.
Installing pip...............done.
virtualenvwrapper.user_scripts creating {your_home_directory}/.virtualenvs/postorius/bin/predeactivate
virtualenvwrapper.user_scripts creating {your_home_directory}/.virtualenvs/postorius/bin/postdeactivate
virtualenvwrapper.user_scripts creating {your_home_directory}/.virtualenvs/postorius/bin/preactivate
virtualenvwrapper.user_scripts creating {your_home_directory}/.virtualenvs/postorius/bin/postactivate
virtualenvwrapper.user_scripts creating {your_home_directory}/.virtualenvs/postorius/bin/get_env_details
(postorius) $}}}

Now you should see (postorius) before your prompt.

For setup on Windows, and more advanced setup, see the [[http://virtualenvwrapper.readthedocs.org/en/latest/install.html|Virtualenvwrapper documentation]].


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

== Install Django ==

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


== Set up sources ==

=== GNU Mailman 3 ===

{{{
(postorius)$ cd mailman 
(postorius)$ python bootstrap.py
(postorius)$ bin/buildout
(postorius)$ bin/test
Line 74: Line 7:

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

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