Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peagah-vieira/djangodash
DjangoDash is a CRM built with Django, featuring a sleek and modern design powered by Tailwind CSS. It provides custom authentication, responsive dashboards, and full CRUD functionality, offering an efficient and intuitive solution for managing customer data.
https://github.com/peagah-vieira/djangodash
crm dashboard django docker docker-compose flowbite postgresql python tailwindcss
Last synced: 8 days ago
JSON representation
DjangoDash is a CRM built with Django, featuring a sleek and modern design powered by Tailwind CSS. It provides custom authentication, responsive dashboards, and full CRUD functionality, offering an efficient and intuitive solution for managing customer data.
- Host: GitHub
- URL: https://github.com/peagah-vieira/djangodash
- Owner: Peagah-Vieira
- License: mit
- Created: 2023-07-03T17:59:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-15T03:21:24.000Z (3 months ago)
- Last Synced: 2024-09-15T08:35:06.867Z (3 months ago)
- Topics: crm, dashboard, django, docker, docker-compose, flowbite, postgresql, python, tailwindcss
- Language: HTML
- Homepage:
- Size: 15 MB
- Stars: 24
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/Peagah-Vieira/Django-CRM/blob/main/README_BR.md)
[](https://www.python.org/downloads/release/python-360/)
# DjangoDash
> DjangoDash is a CRM built with Django, featuring a sleek and modern design powered by Tailwind CSS. It provides custom authentication, responsive dashboards, and full CRUD functionality, offering an efficient and intuitive solution for managing customer data.
>
#### This repo is functionality complete — PRs and issues welcome! Feel free to contact me in my discord server: [pea_gah](https://discord.gg/p9ekhtk44F)
## Functionalities
- Custom login and register authentication
- Password reset with email
- Dashboard with navbar and sidebar
- Custom tables
- Custom pagination
- Custom search
- Custom empty state
- Custom Django-Admin
- Excel export
- Flash messages
- Tailwind CSS
- Light and dark theme
- Responsive
- Unit testing, integration testing and functional testing(Selenium)
- Create, read, update, delete(CRUD)
## Screenshots
Register and login
Create
Update
Delete confirmation
Custom pagination
Dark and light theme
Search and empty state
Excel Export
Responsive
Django Custom Admin
## Running locally
Clone the project
```bash
git clone https://github.com/Peagah-Vieira/Django-CRM-Web-Application
```
Create a virtual environment
```bash
# Linux
sudo apt-get install python3-venv
python3 -m venv .venv
source .venv/bin/activate
# macOS
python3 -m venv .venv
source .venv/bin/activate
# Windows
py -3 -m venv .venv
.venv\scripts\activate
```
Update the pip
```bash
py -m pip install --upgrade pip
```
Install the dependencies
```bash
pip install -r requirements.txt
npm install
```
Copy the .env-example file and make the required configuration changes in the .env file
```bash
cp .env-example .env
```
Compile the Tailwind CSS
```bash
npm run build
```
Perform the migrations
```bash
py manage.py migrate
```
Seed leads app
```bash
py manage.py seed leads --number=50
```
Start the server
```bash
py manage.py runserver
```
## Running Locally(Docker)
Clone the project
```bash
git clone https://github.com/Peagah-Vieira/Django-CRM-Web-Application
```
Copy the .env-example file and make the required configuration changes in the .env file
```bash
cp docker_dotenv_files/.env-example docker_dotenv_files/.env
```
Build and start a Docker container with the services defined in a Docker Compose file
```bash
docker-compose up --build
```
## Running The Tests
To run the tests, run the following command.
Make sure you have the latest [Chromedriver](https://developer.chrome.com/docs/chromedriver) available. (bin/chromedriver.exe)
```bash
coverage run -m pytest
```
Test percentage table (htmlcov/index.html)
```bash
coverage html
```
## Learnings
Good practice concepts:
(https://learndjango.com/tutorials/django-best-practices-projects-vs-apps).
Python requirements file:
(https://learnpython.com/blog/python-requirements-file/)
Write and run tests:
(https://docs.djangoproject.com/en/4.2/topics/testing/overview/)
Test-Driven Development:
(https://www.browserstack.com/guide/what-is-test-driven-development)
Selenium:
(https://django-selenium.readthedocs.io/en/latest/)
Class Based Views:
(https://docs.djangoproject.com/en/4.2/topics/class-based-views/)
PostgreSQL - Naming Conventions:
(https://www.geeksforgeeks.org/postgresql-naming-conventions/)
## Documentation
[Python](https://www.python.org)
[Django](https://www.djangoproject.com)
[PostgreSQL](https://www.postgresql.org/docs/)
[Docker](https://docs.docker.com/)
[Tailwind + Flowbite](https://flowbite.com/docs/getting-started/django/)
[Django Custom Taiwind](https://github.com/Aleksi44/django-admin-tailwind)