Skip to content

SamiiShabuse/Open_Source_CRM_Tool

Repository files navigation

Open Source CRM Tool

A simple, full-stack, open-source Customer Relationship Management (CRM) tool built with Django, PostgreSQL, React, and Docker.

This project is part of my personal learning journey to deepen my skills in building scalable, real-world applications using the same tech stack used by modern SaaS companies.


🚀 Features

  • 📋 Manage customers, deals, and pipelines
  • 📊 Track quotas, revenue goals, and progress
  • 👥 Role-based users (Managers & Reps)
  • 🔐 User authentication system
  • 📈 Dynamic dashboards and reports
  • ⚙️ RESTful API built with Django REST Framework
  • 🎨 Clean, responsive UI with React + Material UI
  • 🐳 Dockerized for local development

🧠 Why I’m Building This

This project is not a clone of any existing product, but rather an original tool to explore:

  • Django & PostgreSQL integration
  • React frontend development
  • API design with DRF
  • Full-stack app architecture
  • Docker-based dev environments

It’s a learning-focused build, but also a working example of how real SaaS apps are built from the ground up.


📦 Tech Stack

Layer Tech
Frontend React, TypeScript, Material UI
Backend Django, Django REST Framework
Database PostgreSQL
Auth Django Auth (token-based)
Dev Tools Docker, Git, VSCode

🛠️ Getting Started

  • IN PROGRESS

1. Clone the repo

git clone https://github.com/yourusername/open-source-crm-tool.git
cd open-source-crm-tool

🧾 Project Standards & Conventions

This project follows two key conventions to maintain clarity, consistency, and professional software practices:

📄 Changelog Format: Keep a Changelog

All notable changes will be documented in CHANGELOG.md using the Keep a Changelog format. This helps track what’s been added, changed, fixed, or removed over time — version by version.

✅ Git Commit Format: Conventional Commits

All commit messages follow the Conventional Commits standard.

Examples:

feat: add user login API with JWT authentication
fix: correct typo in dashboard header
docs: update README with usage instructions

---

## 📚 PR Standards Reference

This project follows professional pull request and contribution practices modeled after:

- [GitHub Pull Request Guidelines](https://docs.github.com/en/pull-requests)
- [Google Code Review Standards](https://google.github.io/eng-practices/review/)
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
- [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

All contributors are encouraged to review these links and follow the same level of professionalism and clarity in their pull requests.

About

An open-source CRM tool built with Django, PostgreSQL, and React to learn and demonstrate full-stack development.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors