146 lines
4.3 KiB
Markdown
146 lines
4.3 KiB
Markdown
# IGNY8 Platform
|
|
|
|
Full-stack SEO keyword management platform built with Django REST Framework and React.
|
|
|
|
## 🏗️ Architecture
|
|
|
|
- **Backend**: Django + DRF (Port 8010/8011)
|
|
- **Frontend**: React + TypeScript + Vite (Port 5173/8021)
|
|
- **Database**: PostgreSQL
|
|
- **Reverse Proxy**: Caddy (HTTPS on port 443)
|
|
|
|
## 📁 Structure
|
|
|
|
```
|
|
igny8/
|
|
├── backend/ # Django backend
|
|
│ ├── igny8_core/ # Django project
|
|
│ │ └── modules/ # Feature modules
|
|
│ │ └── planner/ # Keywords management module
|
|
│ ├── Dockerfile
|
|
│ └── requirements.txt
|
|
├── frontend/ # React frontend
|
|
│ ├── src/
|
|
│ │ ├── pages/ # Page components
|
|
│ │ │ └── Planner/Keywords.tsx
|
|
│ │ ├── services/ # API clients
|
|
│ │ └── components/ # UI components
|
|
│ ├── Dockerfile
|
|
│ ├── Dockerfile.dev # Development mode
|
|
│ └── vite.config.ts
|
|
└── docker-compose.app.yml
|
|
```
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Prerequisites
|
|
- Docker & Docker Compose
|
|
- Node.js 18+ (for local development)
|
|
- Python 3.11+ (for local development)
|
|
|
|
### Development Setup
|
|
|
|
1. **Navigate to the project directory:**
|
|
```bash
|
|
cd /data/app/igny8
|
|
```
|
|
|
|
2. **Backend Setup:**
|
|
```bash
|
|
cd backend
|
|
pip install -r requirements.txt
|
|
python manage.py migrate
|
|
python manage.py createsuperuser
|
|
python manage.py runserver
|
|
```
|
|
|
|
3. **Frontend Setup:**
|
|
```bash
|
|
cd frontend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
4. **Access:**
|
|
- Frontend: http://localhost:5173
|
|
- Backend API: http://localhost:8011/api/
|
|
- Admin: http://localhost:8011/admin/
|
|
|
|
### Docker Setup
|
|
|
|
```bash
|
|
# Build images
|
|
docker build -f backend/Dockerfile -t igny8-backend ./backend
|
|
docker build -f frontend/Dockerfile.dev -t igny8-frontend-dev ./frontend
|
|
|
|
# Run with docker-compose
|
|
docker-compose -f docker-compose.app.yml up
|
|
```
|
|
|
|
## 📚 Features
|
|
|
|
### ✅ Implemented
|
|
- **Foundation**: Multi-tenancy system, Authentication (login/register), RBAC permissions
|
|
- **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, Celery async tasks
|
|
- **Development**: Docker Compose setup, hot reload, TypeScript + React
|
|
|
|
### 🚧 In Progress
|
|
- Planner Dashboard enhancement with KPIs
|
|
- WordPress integration (publishing)
|
|
- Automation & CRON tasks
|
|
|
|
### 🔄 Planned
|
|
- Analytics module enhancements
|
|
- Advanced scheduling features
|
|
- Additional AI model integrations
|
|
|
|
## 🔗 API Endpoints
|
|
|
|
- **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. Start with `docs/README.md` for the complete documentation index.
|
|
|
|
### 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/README.md` for navigation, then start with `docs/01-ARCHITECTURE-TECH-STACK.md` for system overview.
|
|
|
|
## 🛠️ Development
|
|
|
|
### Backend
|
|
- Django 5.2+
|
|
- Django REST Framework
|
|
- PostgreSQL
|
|
|
|
### Frontend
|
|
- React 19
|
|
- TypeScript
|
|
- Vite
|
|
- Tailwind CSS
|
|
|
|
## 📝 License
|
|
|
|
[Add license information]
|
|
|