https://github.com/lorey/personal-crm

🗂 Minimalist personal CRM to keep in touch with contacts
https://github.com/lorey/personal-crm

crm django docker docker-compose personal-crm self-hosted

Last synced: 6 days ago
JSON representation

🗂 Minimalist personal CRM to keep in touch with contacts

• Host: GitHub
• URL: https://github.com/lorey/personal-crm
• Owner: lorey
• Created: 2020-05-24T15:38:20.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-06T23:10:35.000Z (over 2 years ago)
• Last Synced: 2023-02-28T15:21:57.906Z (over 1 year ago)
• Topics: crm, django, docker, docker-compose, personal-crm, self-hosted
• Language: Python
• Homepage:
• Size: 383 KB
• Stars: 23
• Watchers: 3
• Forks: 4
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Keep in touch | my personal CRM

This is a personal CRM I built for myself.

It reminds me to get in touch with my contacts from time to time.

It's a super-small project built with Django, fully dockerized, running locally.

So you can host it wherever you like, hack it however you like, and query the DB with SQL to find out whatever you like.

![Cheesy mockup with a screenshot of my personal CRM](.github/macbook.jpg)

## How it works

Keep in touch lets you store contacts with a frequency to get in touch with them, e.g. 7 days to get in touch once a week. 

* If you haven't contacted the person for this timespan, they will be marked as due to remind you to get in touch. 

* After you've gotten in touch, create a touchpoint and get reminded once the interval is over again.

It's that easy to keep in touch once in a while and has helped me to say in touch with a lot of my contacts.

## Features

* show due contacts to see who to get in touch with

* create touchpoints to remember interactions

* list all contacts with last and next interaction

* search for contacts to save specific interactions

* create contacts with name, frequency, description, and options to get in touch (email, twitter, linkedin, phone)

* import cards from trello (which I used before)

## Installation

The setup with [docker-compose](https://docs.docker.com/compose/) to install and run everything should take less than a minute.

1. run the container (in the background): `docker-compose up -d`

2. create a database with `docker-compose exec web ./manage.py migrate` 

3. create a user for yourself: `docker-compose exec web ./manage.py createsuperuser`

4. open a browser at `localhost:8008` and sign in with the superuser credentials

The directory is mounted into the container, the database can be found at `./db.sqlite3`, e.g. to edit or backup.

### Use the Google integration

Enable Google OAuth to use automated contact, calendar, and interaction discovery:

- see https://django-allauth.readthedocs.io/en/latest/providers.html#google

- in admin, change site to localhost

- add social app: http://localhost:8008/admin/socialaccount/socialapp/add/

- connect your account at http://localhost:8008/accounts/social/connections/

## ToDo

* Improve import by editing afterwards

* Improve import by extracting and using emails

* Merging contacts

* add type of touchpoint and note functionality

## Data Model

![data model](.docs/models.png)

## Related projects

* There's a fully featured, open source personal crm called [monica](https://github.com/monicahq/monica) (PHP, Laravel)

* If you're looking for more features like a diary, notes, relationships, or properties, there's [jens-ox/prm](https://github.com/jens-ox/prm)