https://github.com/modoboa/modoboa-contacts

Address book for Modoboa
https://github.com/modoboa/modoboa-contacts

contacts django modoboa vuejs2

Last synced: 4 days ago
JSON representation

Address book for Modoboa

• Host: GitHub
• URL: https://github.com/modoboa/modoboa-contacts
• Owner: modoboa
• License: mit
• Created: 2017-03-23T13:02:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-17T19:29:34.000Z (5 months ago)
• Last Synced: 2024-10-11T03:19:09.101Z (about 1 month ago)
• Topics: contacts, django, modoboa, vuejs2
• Language: Python
• Size: 1.42 MB
• Stars: 16
• Watchers: 6
• Forks: 10
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Address book plugin for Modoboa

===============================

|gha| |codecov|

Installation

------------

Install this extension system-wide or inside a virtual environment by

running the following command::

  $ pip install modoboa-contacts

Edit the settings.py file of your modoboa instance and apply the following modifications:

- add ``modoboa_contacts`` inside the ``MODOBOA_APPS`` variable like this::

    MODOBOA_APPS = (

        'modoboa',

        'modoboa.core',

        'modoboa.lib',

        'modoboa.admin',

        'modoboa.relaydomains',

        'modoboa.limits',

        'modoboa.parameters',

        # Extensions here

        # ...

        'modoboa_contacts',

    )

- Add the following at the end of the file::

    from modoboa_contacts import settings as modoboa_contacts_settings

    modoboa_contacts_settings.apply(globals())

Finally, run the following commands to setup the database tables::

  $ cd 

  $ python manage.py migrate

  $ python manage.py collectstatic

  $ python manage.py load_initial_data

For developers

---------------

The frontend part of this plugin is developed with `VueJS 2 `_ and

requires `nodejs `_ and `webpack `_.

Once nodejs is installed on your system, run the following commands::

  $ cd frontend

  $ npm install

  $ npm run serve

To update dist files (the ones that will be distributed with the plugin), run::

  $ npm run build

.. |gha| image:: https://github.com/modoboa/modoboa-contacts/actions/workflows/plugin.yml/badge.svg

   :target: https://github.com/modoboa/modoboa-contacts/actions/workflows/plugin.yml

.. |codecov| image:: https://codecov.io/gh/modoboa/modoboa-contacts/branch/master/graph/badge.svg

  :target: https://codecov.io/gh/modoboa/modoboa-contacts