example_project/README.rst

   1 ===============================
   2 Running the example application
   3 ===============================
   4
   5 Assuming you use virtualenv, follow these steps to download and run the
   6 postorius example application in this directory:
   7
   8 ::
   9
  10     $ git clone https://gitlab.com/mailman/postorius.git
  11     $ cd postorius/example_project
  12     $ virtualenv venv
  13     $ . venv/bin/activate
  14     $ pip install -r requirements.txt
  15
  16 Now we need to create the database tables and an admin user.
  17 Run the following and when prompted to create a
  18 superuser choose yes and follow the instructions:
  19
  20 ::
  21
  22     $ python manage.py migrate
  23     $ python manage.py createsuperuser
  24
  25
  26 Now you need to run the Django development server:
  27
  28 ::
  29
  30     $ python manage.py runserver
  31
  32 You should then be able to open your browser on http://127.0.0.1:8000 and see
  33 postorius running.
  34
  35
  36 If you are using the example_application for development, you have to install
  37 postorius and mailmanclient another way. Be sure to have the virtualenv
  38 activated and from the base directory of the respective repositories
  39 you should run:
  40
  41 ::
  42
  43     $ pip install -e .