MailMe - manage your mails.

Warning

MailMe is under heavy development. Please don't use it.

Installation

Note

MailMe is being developed and tested on ArchLinux, Ubuntu and MacOSX. I doubt it'll work on Windows yet.

$ Create your virtualenv (recommended, use virtualenvwrapper)
$ mkvirtualenv mailme

$ # Clone repository
$ git clone git@github.com:mailme/mailme.git

$ # Activate Environment and install
$ workon mailme
$ make develop

$ # run tests
$ make test

Edit settings

Create a new file src/mailme/settings.py with the following content:

from mailme.conf.development import *

Edit and adapt this file to your specific environment.

Setup the database

Note

Please note that MailMe was developed with PostgreSQL in mind. It uses PostgreSQL-specific features and thus doesn't support anything else.

Create an empty new PostgreSQL database (any other supported by Django works too).

$ createdb mailme_dev

Note

You might need to apply a postgresql user (createdb -U youruser) e.g postgres for proper permissions.

$ python manage.py migrate

Superuser

$ # Create a new super user
$ python manage.py createsuperuser

Run the server, celery and other services

Other services being used:

• Celery, is being used to run [regular] tasks, e.g for mail output.

To start all services:

$ honcho start

Note

You can find the SSL version on port 8000

Note

Our celery configuration requires redis to be installed and running. Please make sure it's up!

Run the test-suite

$ make test

Resources

• Documentation
• Bug Tracker
• Code