cwCRM helps you to create best relations index

The example above was created with cwCRM.

Index

• Introduction
• Features
• Getting Set Up On Macintosh
• Getting Set Up On Windows
• Questions? Need Help? Found a bug?

Introduction

This project is one of my first steps as a developer. It is the application of recently acquired knowledge on Django and Python. It was done in a week and a half and will maybe be used as a basis for a future project.

Features

All the basic features expected for the foundation of a CRM :

• Companies profil — manage your address book : create, read, delete and update with automatic mail synchronization. All contact per company are easily accessible.
• Companies profil — manage your address book : create, read, delete and update with automatic mail synchronization.
• Communication archive — Filter your emails by contact or company.

Getting Started with cwCRM

Prerequisites

You're going to need:

• Linux, macOS or Windows
• Python, 3.9.5 doc
• Docker — doc
• Git — doc
• credentials.json- that I must provide you. Once done, you must place it in the "crm" folder where you will find "manage.py"

Getting Set Up On Macintosh

1. Fork this repository on GitHub :
   • clicking on the button as shown in the image, at the top right of the screen, under your profile picture

2. Clone your forked repository (not our original one) to your hard drive:
   • cmd + space on your keyboard to open spotlight
   • search Terminal and launch it
   • copy-paste the following command git clone https://github.com/YOURUSERNAME/cw_crm.git(don't forget to change YOURUSERNAME in the previous command by your github username)
3. Open cw_crm folder:
   • cmd + space on your keyboard to open spotlight
   • search cw_crm folder and open it
4. Place "credentials.json" in the "crm" folder
5. Open Docker on your computer :
   • cmd + space on your keyboard to open spotlight
   • search Docker and launch it (the application will launch in the background)
6. Back to your Terminal, copy-paste cd cw_crm
7. And finnaly, copy-pastedocker compose up

You will be able to access your site at http://127.0.0.1:8000 until you stop the running container process in docker app.

Getting Set Up On Windows

1. Fork this repository on GitHub :
   • clicking on the button as shown in the image, at the top right of the screen, under your profile picture

2. Clone your forked repository (not our original one) to your hard drive:
   • in the search bar located on the left-hand side of your taskbar
   • search Command Prompt and launch it
   • copy-paste the following command `git clone https://github.com/YOURUSERNAME/cw_crm.git (don't forget to change YOURUSERNAME in the previous command by your github username)
3. Open cw_crm folder:
   • in the search bar located on the left-hand side of your taskbar
   • search cw_crm folder and open it
4. Place "credentials.json" in the "crm" folder
5. Open Docker on your computer :
   • in the search bar located on the left-hand side of your taskbar
   • search Docker and launch it (the application will launch in the background)
6. Back to your Command Prompt, copy-paste cd cw_crm
7. And finnaly, copy-pastedocker compose up

You will be able to access your site at http://127.0.0.1:8000 until you stop the running container process in docker app.

Questions? Need Help? Found a bug?

If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to contact me on linkedin!

Found a bug with upstream cwCRM? Go ahead and submit an issue.

Special Thanks

• Django project
• Font Awesome
• Bootstrap
• Google developers
• Flaticon