DOCS
This commit is contained in:
45
README.md
45
README.md
@@ -81,39 +81,50 @@ docker-compose -f docker-compose.app.yml up
|
||||
|
||||
### ✅ Implemented
|
||||
- **Foundation**: Multi-tenancy system, Authentication (login/register), RBAC permissions
|
||||
- **Planner Module**: Keywords & Clusters (full CRUD, filtering, pagination, bulk operations, CSV import/export)
|
||||
- **Planner Module**: Keywords, Clusters, Content Ideas (full CRUD, filtering, pagination, bulk operations, CSV import/export)
|
||||
- **Writer Module**: Tasks, Content, Images (full CRUD, content generation, image generation)
|
||||
- **Thinker Module**: Prompts, Author Profiles, Strategies, Image Testing
|
||||
- **System Module**: Settings, Integrations (OpenAI, Runware), AI Prompts
|
||||
- **Billing Module**: Credits, Transactions, Usage Logs
|
||||
- **AI Functions**: 5 AI operations (Auto Cluster, Generate Ideas, Generate Content, Generate Image Prompts, Generate Images)
|
||||
- **Frontend**: Complete component library, 4 master templates, config-driven UI system
|
||||
- **Backend**: REST API with tenant isolation, Site > Sector hierarchy
|
||||
- **Backend**: REST API with tenant isolation, Site > Sector hierarchy, Celery async tasks
|
||||
- **Development**: Docker Compose setup, hot reload, TypeScript + React
|
||||
|
||||
### 🚧 In Progress
|
||||
- Content Ideas module (backend + frontend)
|
||||
- AI integration for auto-clustering and idea generation
|
||||
- Planner Dashboard enhancement with KPIs
|
||||
- WordPress integration (publishing)
|
||||
- Automation & CRON tasks
|
||||
|
||||
### 🔄 Planned
|
||||
- Writer module (Tasks, Drafts, Published)
|
||||
- Thinker module (Prompts, Strategies, Image Testing)
|
||||
- AI Pipeline infrastructure
|
||||
- WordPress integration
|
||||
- Automation & CRON tasks
|
||||
- Analytics module enhancements
|
||||
- Advanced scheduling features
|
||||
- Additional AI model integrations
|
||||
|
||||
## 🔗 API Endpoints
|
||||
|
||||
- **Keywords**: `/api/planner/keywords/`
|
||||
- **Planner**: `/api/v1/planner/keywords/`, `/api/v1/planner/clusters/`, `/api/v1/planner/ideas/`
|
||||
- **Writer**: `/api/v1/writer/tasks/`, `/api/v1/writer/images/`
|
||||
- **System**: `/api/v1/system/settings/`
|
||||
- **Billing**: `/api/v1/billing/`
|
||||
- **Admin**: `/admin/`
|
||||
|
||||
See `docs/04-BACKEND.md` for complete API reference.
|
||||
|
||||
## 📖 Documentation
|
||||
|
||||
All documentation is consolidated in the `/docs/` folder:
|
||||
All documentation is consolidated in the `/docs/` folder. Start with `docs/README.md` for the complete documentation index.
|
||||
|
||||
- **`docs/01-ARCHITECTURE.md`** - System architecture, design patterns, and key principles
|
||||
- **`docs/02-IMPLEMENTATION-ROADMAP.md`** - Complete build roadmap with 21 phases
|
||||
- **`docs/03-CURRENT-STATUS.md`** - Current progress, completed items, and next steps
|
||||
- **`docs/04-API-REFERENCE.md`** - API endpoints reference guide
|
||||
- **`docs/05-WP-MIGRATION-MAP.md`** - WordPress plugin to Django app migration reference
|
||||
### Core Documentation
|
||||
- **`docs/README.md`** - Documentation index and navigation
|
||||
- **`docs/01-ARCHITECTURE-TECH-STACK.md`** - Technology stack and system architecture
|
||||
- **`docs/02-APP-ARCHITECTURE.md`** - Application architecture with complete workflows
|
||||
- **`docs/03-FRONTEND.md`** - Complete frontend documentation
|
||||
- **`docs/04-BACKEND.md`** - Complete backend documentation
|
||||
- **`docs/05-AI-FUNCTIONS.md`** - Complete AI functions documentation
|
||||
- **`docs/06-CHANGELOG.md`** - System changelog
|
||||
|
||||
**Quick Start**: Read `docs/03-CURRENT-STATUS.md` for current state, then `docs/02-IMPLEMENTATION-ROADMAP.md` for what to build next.
|
||||
**Quick Start**: Read `docs/README.md` for navigation, then start with `docs/01-ARCHITECTURE-TECH-STACK.md` for system overview.
|
||||
|
||||
## 🛠️ Development
|
||||
|
||||
|
||||
Reference in New Issue
Block a user