{"id":25860718,"url":"https://github.com/mehedimk/djangodoo-docs","last_synced_at":"2025-03-01T22:57:16.071Z","repository":{"id":279297054,"uuid":"938288985","full_name":"MehediMK/DjangoDoo-docs","owner":"MehediMK","description":"Guideline for An open-source DjangoDoo Modular Multipurpose Application Framework, streamline development, simplify integrations, and build tailored, open-source solutions for your business needs.","archived":false,"fork":false,"pushed_at":"2025-02-24T20:25:30.000Z","size":860,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-24T21:29:22.565Z","etag":null,"topics":["django","djangodoo","erp","framework","website","website-development"],"latest_commit_sha":null,"homepage":"https://mehedimk.github.io/DjangoDoo-docs/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MehediMK.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-24T18:06:27.000Z","updated_at":"2025-02-24T20:30:14.000Z","dependencies_parsed_at":"2025-02-24T21:30:17.011Z","dependency_job_id":"d8b4ae2d-732f-45b9-9509-d9ac36fffed7","html_url":"https://github.com/MehediMK/DjangoDoo-docs","commit_stats":null,"previous_names":["mehedimk/djangodoo-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MehediMK%2FDjangoDoo-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MehediMK%2FDjangoDoo-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MehediMK%2FDjangoDoo-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MehediMK%2FDjangoDoo-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MehediMK","download_url":"https://codeload.github.com/MehediMK/DjangoDoo-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241435138,"owners_count":19962402,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","djangodoo","erp","framework","website","website-development"],"created_at":"2025-03-01T22:57:14.869Z","updated_at":"2025-03-01T22:57:16.056Z","avatar_url":"https://github.com/MehediMK.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📖 DjangoDoo Documentation  \n\nWelcome to the **DjangoDoo-Docs** repository! This project provides comprehensive documentation for **DjangoDoo**, a modular and extensible application framework built with **Django**, inspired by Odoo.\n\n---\n- [🚀 **Live Documentation URL**](https://mehedimk.github.io/DjangoDoo-docs/)\n- [📦 **DjangoDoo Project URL**](https://github.com/MehediMK/djangodoo)\n---\n\n## 🚀 About DjangoDoo  \n\nDjangoDoo is a **multi-purpose application framework** designed to bring modularity and flexibility to Django-based projects.  \nIt includes:  \n✔ **Dynamic Module System** – Load/unload modules easily  \n✔ **Advanced Views** – List, Kanban, Graph, Form views  \n✔ **Real-time OnChange \u0026 Compute Methods** – Like Odoo  \n✔ **Plugin \u0026 Extension Support** – Customize as needed  \n✔ **REST API Integration** – Extend with external services  \n\nCheck out the **[DjangoDoo GitHub Repository](https://github.com/MehediMK/djangodoo)** to explore the main project.\n\n---\n\n## 📘 About This Documentation  \n\nThis 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.  \n\n\n### 📂 Documentation Structure  \n\n- `docs/index.md` → Home Page  \n- `docs/getting-started.md` → Installation \u0026 Setup  \n- `docs/modules.md` → Creating \u0026 Managing Modules  \n- `docs/contributing.md` → How to Contribute  \n- `docs/faq.md` → Frequently Asked Questions  \n- `mkdocs.yml` → Configuration File  \n\n---\n\n## 🔧 How to Build the Documentation  \n\nTo contribute or run the documentation locally, follow these steps:\n\n### 📥 1️⃣ Install MkDocs  \nFirst, install **MkDocs** and required plugins:  \n\n```bash\npip install -r requirements.txt\n```\n\n### 📜 2️⃣ Clone the Repository  \n```bash\ngit clone https://github.com/MehediMK/djangodoo-docs.git\ncd djangodoo-docs\n```\n\n### 🚀 3️⃣ Run MkDocs Locally  \n```bash\nmkdocs serve\n```\nThis starts a local server at `http://127.0.0.1:8000/`, where you can preview the documentation.\n\n### 🛠 📦 Update Github Page\n```bash\nmkdocs gh-deploy\n```\n\n### 📤 4️⃣ Build Static HTML Files  \nTo generate static HTML files for deployment:  \n```bash\nmkdocs build\n```\nThis creates a `site/` directory with the compiled documentation.\n\n---\n\n## 🤝 How to Contribute  \n\nWe welcome contributions from the community! You can contribute by:  \n\n✔ **Improving Documentation** – Fix typos, add missing details  \n✔ **Adding New Guides** – Write tutorials, explain features  \n✔ **Reporting Issues** – Found something unclear? Let us know!  \n\nCheck out the **[Contributing Guide](docs/contributing.md)** for detailed instructions.\n\n---\n\n## 📌 License  \n\nDjangoDoo-Docs is open-source and licensed under the **MIT License**.\n\n---\n\n## ⭐ Stay Connected  \n\n💬 **GitHub Discussions** (Coming Soon)  \n📢 Follow us on **LinkedIn \u0026 Twitter**  \n📧 Contact: [DjangoDoo GitHub Issues](https://github.com/MehediMK/djangodoo/issues)  \n\n**If you like this project, don't forget to ⭐ star the repository!**  \n```\n\n---\n\n### **Why This README?**\n- **Clear overview** of the DjangoDoo documentation project.\n- **Easy setup instructions** for contributors.\n- **Encourages community participation** by outlining contribution guidelines.\n- **Professional \u0026 well-structured** for open-source adoption.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmehedimk%2Fdjangodoo-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmehedimk%2Fdjangodoo-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmehedimk%2Fdjangodoo-docs/lists"}