https://github.com/mehedimk/djangodoo-docs
Guideline for 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-docs
django djangodoo erp framework website website-development
Last synced: 3 months ago
JSON representation
Guideline for 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-docs
- Owner: MehediMK
- Created: 2025-02-24T18:06:27.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-24T20:25:30.000Z (3 months ago)
- Last Synced: 2025-02-24T21:29:22.565Z (3 months ago)
- Topics: django, djangodoo, erp, framework, website, website-development
- Homepage: https://mehedimk.github.io/DjangoDoo-docs/
- Size: 840 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# 📖 DjangoDoo Documentation
Welcome to the **DjangoDoo-Docs** repository! This project provides comprehensive documentation for **DjangoDoo**, a modular and extensible application framework built with **Django**, inspired by Odoo.
---
- [🚀 **Live Documentation URL**](https://mehedimk.github.io/DjangoDoo-docs/)
- [📦 **DjangoDoo Project URL**](https://github.com/MehediMK/djangodoo)
---
## 🚀 About DjangoDoo
DjangoDoo is a **multi-purpose application framework** designed to bring modularity and flexibility to Django-based projects.
It includes:
✔ **Dynamic Module System** – Load/unload modules easily
✔ **Advanced Views** – List, Kanban, Graph, Form views
✔ **Real-time OnChange & Compute Methods** – Like Odoo
✔ **Plugin & Extension Support** – Customize as needed
✔ **REST API Integration** – Extend with external services
Check out the **[DjangoDoo GitHub Repository](https://github.com/MehediMK/djangodoo)** to explore the main project.
---
## 📘 About This Documentation
This repository contains the **official documentation** for DjangoDoo, built using **MkDocs**. It helps users and contributors understand DjangoDoo's architecture, features, and how to get started.
### 📂 Documentation Structure
- `docs/index.md` → Home Page
- `docs/getting-started.md` → Installation & Setup
- `docs/modules.md` → Creating & Managing Modules
- `docs/contributing.md` → How to Contribute
- `docs/faq.md` → Frequently Asked Questions
- `mkdocs.yml` → Configuration File
---
## 🔧 How to Build the Documentation
To contribute or run the documentation locally, follow these steps:
### 📥 1️⃣ Install MkDocs
First, install **MkDocs** and required plugins:
```bash
pip install -r requirements.txt
```
### 📜 2️⃣ Clone the Repository
```bash
git clone https://github.com/MehediMK/djangodoo-docs.git
cd djangodoo-docs
```
### 🚀 3️⃣ Run MkDocs Locally
```bash
mkdocs serve
```
This starts a local server at `http://127.0.0.1:8000/`, where you can preview the documentation.
### 🛠 📦 Update Github Page
```bash
mkdocs gh-deploy
```
### 📤 4️⃣ Build Static HTML Files
To generate static HTML files for deployment:
```bash
mkdocs build
```
This creates a `site/` directory with the compiled documentation.
---
## 🤝 How to Contribute
We welcome contributions from the community! You can contribute by:
✔ **Improving Documentation** – Fix typos, add missing details
✔ **Adding New Guides** – Write tutorials, explain features
✔ **Reporting Issues** – Found something unclear? Let us know!
Check out the **[Contributing Guide](docs/contributing.md)** for detailed instructions.
---
## 📌 License
DjangoDoo-Docs is open-source and licensed under the **MIT License**.
---
## ⭐ Stay Connected
💬 **GitHub Discussions** (Coming Soon)
📢 Follow us on **LinkedIn & Twitter**
📧 Contact: [DjangoDoo GitHub Issues](https://github.com/MehediMK/djangodoo/issues)
**If you like this project, don't forget to ⭐ star the repository!**
```
---
### **Why This README?**
- **Clear overview** of the DjangoDoo documentation project.
- **Easy setup instructions** for contributors.
- **Encourages community participation** by outlining contribution guidelines.
- **Professional & well-structured** for open-source adoption.