https://github.com/mehedimk/djangodoo
An open-source DjangoDoo Modular Multipurpose Application Framework, streamline development, simplify integrations, and build tailored, open-source solutions for your business needs.
https://github.com/mehedimk/djangodoo
business django djangodoo erp odoo website
Last synced: 3 months ago
JSON representation
An open-source DjangoDoo Modular Multipurpose Application Framework, streamline development, simplify integrations, and build tailored, open-source solutions for your business needs.
- Host: GitHub
- URL: https://github.com/mehedimk/djangodoo
- Owner: MehediMK
- License: gpl-3.0
- Created: 2024-12-31T01:12:49.000Z (5 months ago)
- Default Branch: 1.0
- Last Pushed: 2025-02-21T13:06:40.000Z (3 months ago)
- Last Synced: 2025-02-21T14:19:38.030Z (3 months ago)
- Topics: business, django, djangodoo, erp, odoo, website
- Language: Python
- Homepage:
- Size: 60.5 KB
- Stars: 3
- Watchers: 1
- Forks: 5
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# DjangoDoo: A Modular, Versatile Application Framework
## About the Project
DjangoDoo is an open-source framework designed to be a flexible platform for building diverse applications, inspired by the modular architecture of Odoo. Built on the Django framework, DjangoDoo enables developers to create scalable, extensible, and maintainable applications through a modular design. Each module in DjangoDoo operates independently, with its own models, views, templates, and configurations. Modules can be dynamically enabled or disabled without affecting the core system.
This project aims to provide an efficient and flexible solution for developers looking to build complex applications with ease.
### Key Features
- **Dynamic Module Loading**: Modules can be enabled or disabled dynamically.
- **Independent Modules**: Each module has its own models, views, templates, migrations, and configurations.
- **Module Dependencies**: Modules can define dependencies on other modules.
- **Centralized Module Registry**: All modules are registered and managed from a central location.
- **Extensible Admin Interface**: Manage modules directly from the Django admin panel.
- **Custom Reporting and Logging**: Modules can implement custom reporting and logging mechanisms.
- **Version Control for Modules**: Track and manage the version of each module.
---
## Project Structure
```
djangodoo/
├── djangodoo/ # Core app for managing modules
│ ├── admin.py # Admin interface for modules
│ ├── models.py # Module registry model
│ ├── management/ # Custom management commands
│ │ └── commands/
│ │ ├── load_modules.py
│ │ └── apply_module_migrations.py
├── modules/ # Folder containing all modules
│ ├── sales/ # Example module: Sales
│ │ ├── migrations/ # Independent migrations for this module
│ │ ├── admin.py # Admin for register models into admin dashboard
│ │ ├── apps.py # Apps for module information (name, version, icon, etc)
│ │ ├── models.py # Models for this module
│ │ ├── views.py # Views for this module
│ │ ├── templates/ # Templates for this module
│ │ └── __init__.py # Module configuration
│ ├── inventory/ # Example module: Inventory
├── templates/ # Global templates
├── manage.py # Django's CLI entry point
├── requirements.txt # Python dependencies
└── README.md # Project documentation
```
---
## Setup Instructions
Follow the steps below to set up the project locally:
### Prerequisites
- Python 3.10+
- Django 4.x
- A supported database (e.g., SQLite, PostgreSQL)
### Step 1: Clone the Repository
```bash
git clone https://github.com/MehediMK/djangodoo.git
cd djangodoo
```
### Step 2: Create and Activate a Virtual Environment
```bash
python -m venv venv # On Unix or MacOS
source venv/bin/activate # On Windows: venv\Scripts\activate
```
### Step 3: Install Dependencies
```bash
pip install -r requirements.txt
```
### step 4: Setup Configuration in config.py
```bash
copy "config.py sample" config.py
```
### Step 5: Apply Initial Migrations
Run migrations for the core system:
```bash
python manage.py migrate
```
### Step 6: Register and Enable Modules
1. Place your modules inside the `modules/` directory.
2. Use the `load_modules` management command to register modules:
```bash
python manage.py load_modules
```
3. Enable desired modules from the Django admin panel (Core > Modules).
### Step 7: Apply Module Migrations
Run migrations for all enabled modules:
```bash
python manage.py apply_module_migrations
```
### Step 8: Start the Development Server
```bash
python manage.py runserver
```
Visit `http://127.0.0.1:8000` in your browser.
---
## Usage
### Adding a New Module
1. Create a new folder in the `modules/` directory, e.g., `modules/new_module/`.
2. Define your module's configuration in `apps.py`:
```python
class ModuleConfig:
name = "New Module"
# Add custom fields
description = "Description of the new module"
dependencies = [] # List of module names this module depends on
version = '1.0.0'
# icon Path must be in your module static directory with module name
icon = "module_name/icon.png"
```
3. Add your models, views, templates, and migrations in the new module folder.
4. Register the module using the `load_modules` command.
### Managing Modules
- **Enable/Disable Modules**: Use the admin panel or update the `enabled` field in the `Module` model directly.
- **Verify Module Dependencies**: Ensure all dependencies are enabled before activating a module.
- **Apply Module Migrations**: Use the `apply_module_migrations` command.
---
## Contributing
Contributions are welcome! Please follow these steps to contribute [CONTRIBUTING](CONTRIBUTING.md):
1. Fork the repository.
2. Create a feature branch (`git checkout -b feature-name`).
3. Commit your changes (`git commit -m "Add feature"`).
4. Open a pull request from parent branch (`git pull origin parent-branch`).
5. Push to the branch (`git push origin feature-name`).
---