|
| 1 | +Django-CRM |
| 2 | +========== |
| 3 | + |
| 4 | +Django CRM is opensource CRM developed on django framework. It has all |
| 5 | +the basic features of CRM to start with. We welcome code contributions |
| 6 | +and feature requests via github. |
| 7 | + |
| 8 | +http://django-crm.readthedocs.io for latest documentation |
| 9 | + |
| 10 | +This project contains the following modules: |
| 11 | + |
| 12 | + - Contacts |
| 13 | + - Accounts |
| 14 | + - Invoices |
| 15 | + - Cases |
| 16 | + - Leads |
| 17 | + - Opportunity |
| 18 | + - Planner |
| 19 | + |
| 20 | +## Try for free `here <https://bottlecrm.com/>`__ |
| 21 | +------------------------------------------------- |
| 22 | + |
| 23 | +Installation |
| 24 | +============ |
| 25 | + |
| 26 | +We recommend ubuntu 18.04 or ubuntu 20.04. These instructions are |
| 27 | +verified for ubuntu 20.04. |
| 28 | + |
| 29 | +#### System Requirements |
| 30 | +------------------------ |
| 31 | + |
| 32 | +:: |
| 33 | + |
| 34 | + sudo apt install postgresql xvfb libfontconfig wkhtmltopdf git libpq-dev python3-dev python3-pip gem ruby ruby-dev build-essential libssl-dev libffi-dev python3-venv redis-server redis-tools virtualenv -y |
| 35 | + |
| 36 | + sudo gem install sass |
| 37 | + |
| 38 | + sudo apt-get install postfix |
| 39 | + |
| 40 | +postfix package installation process |
| 41 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 42 | + |
| 43 | +- After running ``sudo apt-get install postfix`` in terminal, select |
| 44 | + ``Internet`` as a configuration from the pop-up and click ok. Next it |
| 45 | + will ask to enter the ``System mail name`` which will be the used as |
| 46 | + a ``From Email Address`` during sending the mail. |
| 47 | + |
| 48 | +#### Install dependencies |
| 49 | +------------------------- |
| 50 | + |
| 51 | +- Create and activate a virtual environment. |
| 52 | + |
| 53 | +:: |
| 54 | + |
| 55 | + virtualenv venv |
| 56 | + source venv/bin/activate |
| 57 | + |
| 58 | +- Install the project's dependencie |
| 59 | + |
| 60 | +:: |
| 61 | + |
| 62 | + pip install -r requirements.txt |
| 63 | + |
| 64 | +env variables |
| 65 | +^^^^^^^^^^^^^ |
| 66 | + |
| 67 | +- Then refer to ``env.md`` for environment variables and keep those in |
| 68 | + the ``.env`` file in the current folder as your project is in. |
| 69 | +- Add ``127.0.0.1 test.localhost`` to your hosts file ``/etc/hosts``. |
| 70 | + Then you can use test as company name to register and login. |
| 71 | + |
| 72 | +next steps |
| 73 | +^^^^^^^^^^ |
| 74 | + |
| 75 | +:: |
| 76 | + |
| 77 | + python manage.py migrate |
| 78 | + python manage.py runserver |
| 79 | + |
| 80 | +Then open http://localhost:8000 in your borwser and create a new account |
| 81 | +with test as company name. We mapped ``test.localhost`` to |
| 82 | +``127.0.0.1``. So, it should work properly. |
| 83 | + |
| 84 | +To edit content |
| 85 | +~~~~~~~~~~~~~~~ |
| 86 | + |
| 87 | +:: |
| 88 | + |
| 89 | + python manage.py create_blog_user 'username' |
| 90 | + |
| 91 | +The above command will add the user as blog admin to edit content at |
| 92 | +/blog/admin/ |
| 93 | + |
| 94 | +Useful tools and packages |
| 95 | +~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 96 | + |
| 97 | +:: |
| 98 | + |
| 99 | + pipdeptree # to see pip dependancy tree |
| 100 | + black # to format code to meet python coding standards |
| 101 | + pip-check -H # to see upgradable packages |
| 102 | + |
| 103 | +Community |
| 104 | +========= |
| 105 | + |
| 106 | +Get help or stay up to date. |
| 107 | + |
| 108 | +- `Issues <https://github.com/MicroPyramid/Django-CRM/issues>`__ |
| 109 | +- Follow [@micropyramid](https://twitter.com/micropyramid) on Twitter |
| 110 | +- Ask questions on `Stack |
| 111 | + Overflow <https://stackoverflow.com/questions/tagged/django-crm>`__ |
| 112 | +- Chat with community |
| 113 | + `Gitter <https://gitter.im/MicroPyramid/Django-CRM>`__ |
| 114 | +- For customisations, email to [email protected] |
| 115 | + |
| 116 | +Credits |
| 117 | +------- |
| 118 | + |
| 119 | +Contributors |
| 120 | +============ |
| 121 | + |
| 122 | +This project exists thanks to all the people who contribute! |
| 123 | + |
| 124 | +.. figure:: https://opencollective.com/django-crm/contributors.svg?width=890&button=false |
| 125 | + :alt: image |
| 126 | + |
| 127 | +Feature requests and bug reports |
| 128 | +================================ |
| 129 | + |
| 130 | +We welcome your feedback and support, raise github issue if you want to |
| 131 | +report a bug or request new feature. we are glad to help. |
| 132 | + |
| 133 | +For commercial support `Contact |
| 134 | +us <https://micropyramid.com/contact-us/>`__ |
0 commit comments