Alwrity version 0.5.4
This commit is contained in:
ajaysi
317
SETUP_GUIDE.md
317
SETUP_GUIDE.md
@@ -3,27 +3,43 @@
|
||||
## 🚀 **Quick Start**
|
||||
|
||||
### **Prerequisites**
|
||||
- Python 3.8+
|
||||
- Node.js 16+
|
||||
- Python 3.10+
|
||||
- Node.js 18+
|
||||
- npm or yarn
|
||||
- Git
|
||||
|
||||
---
|
||||
|
||||
## 📋 **Complete Setup Steps**
|
||||
|
||||
### **1. Backend Setup**
|
||||
### **1. Clone and Setup Repository**
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/AJaySi/AI-Writer.git
|
||||
cd AI-Writer
|
||||
|
||||
#### **Option B: Run from backend directory**
|
||||
# Install Python dependencies
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### **2. Backend Setup (FastAPI)**
|
||||
|
||||
#### **Option A: Using the start_alwrity_backend script (Recommended)**
|
||||
```bash
|
||||
# From project root
|
||||
python start_alwrity_backend.py
|
||||
```
|
||||
|
||||
#### **Option B: Manual backend startup**
|
||||
```bash
|
||||
cd backend
|
||||
pip install -r requirements.txt
|
||||
python main.py
|
||||
python -m uvicorn main:app --reload --host 0.0.0.0 --port 8000
|
||||
```
|
||||
|
||||
**Backend will be available at:** http://localhost:8000
|
||||
|
||||
### **2. Frontend Setup**
|
||||
### **3. Frontend Setup (React)**
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
@@ -35,7 +51,7 @@ npm start
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ **New Architecture Overview**
|
||||
## 🏗️ **Current Architecture Overview**
|
||||
|
||||
### **Project Structure**
|
||||
```
|
||||
@@ -43,58 +59,58 @@ alwrity/
|
||||
├── backend/ # FastAPI Backend
|
||||
│ ├── main.py # Main FastAPI application
|
||||
│ ├── api/
|
||||
│ │ ├── onboarding.py # Core onboarding endpoints
|
||||
│ │ └── component_logic.py # Advanced component endpoints
|
||||
│ ├── services/
|
||||
│ │ ├── api_key_manager.py # API key management service
|
||||
│ │ ├── validation.py # Validation services
|
||||
│ │ └── component_logic/ # Component logic services
|
||||
│ │ ├── ai_research_logic.py
|
||||
│ │ ├── personalization_logic.py
|
||||
│ │ └── research_utilities.py
|
||||
│ │ ├── content_planning/ # Content planning endpoints
|
||||
│ │ │ ├── api/
|
||||
│ │ │ │ ├── enhanced_strategy_routes.py
|
||||
│ │ │ │ └── router.py
|
||||
│ │ │ └── services/
|
||||
│ │ │ ├── content_strategy/ # Modular services
|
||||
│ │ │ │ ├── core/
|
||||
│ │ │ │ ├── ai_analysis/
|
||||
│ │ │ │ ├── onboarding/
|
||||
│ │ │ │ ├── performance/
|
||||
│ │ │ │ ├── utils/
|
||||
│ │ │ │ └── autofill/
|
||||
│ │ │ └── enhanced_strategy_service.py
|
||||
│ │ └── onboarding.py # Onboarding endpoints
|
||||
│ ├── models/
|
||||
│ │ ├── onboarding.py # Database models
|
||||
│ │ └── component_logic.py # Component logic models
|
||||
│ └── requirements.txt # Python dependencies
|
||||
│ │ ├── enhanced_strategy_models.py
|
||||
│ │ └── onboarding.py
|
||||
│ ├── services/
|
||||
│ │ ├── ai_service_manager.py
|
||||
│ │ └── llm_providers/
|
||||
│ └── requirements.txt
|
||||
│
|
||||
├── frontend/ # React Frontend
|
||||
│ ├── src/
|
||||
│ │ ├── App.tsx # Main app with onboarding check
|
||||
│ │ ├── App.tsx # Main app component
|
||||
│ │ ├── components/
|
||||
│ │ │ ├── OnboardingWizard/ # Complete onboarding flow
|
||||
│ │ │ │ ├── common/ # Design system components
|
||||
│ │ │ │ │ ├── useOnboardingStyles.ts
|
||||
│ │ │ │ │ ├── onboardingUtils.ts
|
||||
│ │ │ │ │ ├── OnboardingStepLayout.tsx
|
||||
│ │ │ │ │ ├── OnboardingCard.tsx
|
||||
│ │ │ │ │ └── OnboardingButton.tsx
|
||||
│ │ │ │ ├── ApiKeyStep.tsx
|
||||
│ │ │ │ ├── WebsiteStep.tsx
|
||||
│ │ │ │ ├── ResearchStep.tsx
|
||||
│ │ │ │ ├── PersonalizationStep.tsx
|
||||
│ │ │ │ ├── IntegrationsStep.tsx
|
||||
│ │ │ │ ├── FinalStep.tsx
|
||||
│ │ │ │ └── ResearchTestStep.tsx
|
||||
│ │ │ └── MainApp.tsx # Main application
|
||||
│ │ └── api/
|
||||
│ │ ├── onboarding.ts # Onboarding API integration
|
||||
│ │ └── componentLogic.ts # Component logic API integration
|
||||
│ └── package.json # Node.js dependencies
|
||||
│ │ │ ├── ContentPlanningDashboard/
|
||||
│ │ │ │ ├── components/
|
||||
│ │ │ │ │ ├── ContentStrategyBuilder.tsx
|
||||
│ │ │ │ │ ├── ProgressTracker.tsx
|
||||
│ │ │ │ │ └── StrategicInputField.tsx
|
||||
│ │ │ │ └── stores/
|
||||
│ │ │ │ └── enhancedStrategyStore.ts
|
||||
│ │ │ └── OnboardingWizard/
|
||||
│ │ ├── services/
|
||||
│ │ │ └── contentPlanningApi.ts
|
||||
│ │ └── utils/
|
||||
│ └── package.json
|
||||
│
|
||||
└── lib/utils/api_key_manager/ # Legacy Streamlit (reference only)
|
||||
├── onboarding_progress.py # Migrated to backend
|
||||
├── components/ # Migrated to React
|
||||
└── ...
|
||||
├── start_alwrity_backend.py # Backend startup script
|
||||
├── requirements.txt # Python dependencies
|
||||
└── README.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 **Development Mode**
|
||||
|
||||
### **Terminal 1: Backend**
|
||||
### **Terminal 1: Backend (Recommended)**
|
||||
```bash
|
||||
# From project root
|
||||
python run_backend.py
|
||||
# From project root - uses the startup script
|
||||
python start_alwrity_backend.py
|
||||
```
|
||||
|
||||
### **Terminal 2: Frontend**
|
||||
@@ -113,83 +129,75 @@ curl http://localhost:8000/health
|
||||
```
|
||||
**Expected Response:**
|
||||
```json
|
||||
{"status":"healthy","timestamp":"2025-07-28T18:14:35.749581"}
|
||||
{"status":"healthy","timestamp":"2025-08-10T12:55:16.132"}
|
||||
```
|
||||
|
||||
### **2. Test Onboarding Check**
|
||||
### **2. Test Content Planning API**
|
||||
```bash
|
||||
curl http://localhost:8000/api/check-onboarding
|
||||
```
|
||||
**Expected Response:**
|
||||
```json
|
||||
{"onboarding_required":false,"onboarding_complete":true}
|
||||
# Test enhanced strategy endpoints
|
||||
curl http://localhost:8000/api/content-planning/enhanced-strategies/health
|
||||
|
||||
# Test autofill functionality
|
||||
curl -X POST http://localhost:8000/api/content-planning/enhanced-strategies/autofill/refresh \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"user_id": 1, "use_ai": true, "ai_only": true}'
|
||||
```
|
||||
|
||||
### **3. Test Component Logic Endpoints**
|
||||
### **3. Test Onboarding Endpoints**
|
||||
```bash
|
||||
# Test AI Research endpoint
|
||||
curl -X POST http://localhost:8000/api/onboarding/ai-research/validate-user \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"full_name": "John Doe", "email": "john@example.com", "company": "Test Corp", "role": "Developer"}'
|
||||
# Test onboarding status
|
||||
curl http://localhost:8000/api/onboarding/status
|
||||
|
||||
# Test Personalization endpoint
|
||||
curl -X POST http://localhost:8000/api/onboarding/personalization/validate-style \
|
||||
# Test API key validation
|
||||
curl -X POST http://localhost:8000/api/onboarding/providers/openai/validate \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"writing_style": "Professional", "tone": "Formal", "content_length": "Standard"}'
|
||||
-d '{"api_key": "sk-your-openai-key"}'
|
||||
```
|
||||
|
||||
### **4. Test Frontend**
|
||||
- Open http://localhost:3000 in your browser
|
||||
- You should see the ALwrity application with modern React interface
|
||||
- Navigate to Content Planning Dashboard to test the new features
|
||||
|
||||
---
|
||||
|
||||
## 📊 **API Endpoints Overview**
|
||||
|
||||
### **Core Endpoints (12 Total)**
|
||||
### **Content Planning Endpoints**
|
||||
```python
|
||||
# Health and Status
|
||||
GET /health # Health check
|
||||
GET /api/status # Application status
|
||||
# Enhanced Strategy Endpoints
|
||||
GET /api/content-planning/enhanced-strategies/health
|
||||
GET /api/content-planning/enhanced-strategies/
|
||||
POST /api/content-planning/enhanced-strategies/
|
||||
GET /api/content-planning/enhanced-strategies/{strategy_id}
|
||||
PUT /api/content-planning/enhanced-strategies/{strategy_id}
|
||||
DELETE /api/content-planning/enhanced-strategies/{strategy_id}
|
||||
|
||||
# Onboarding Endpoints
|
||||
GET /api/onboarding/status # Get onboarding status
|
||||
GET /api/onboarding/progress # Get full progress data
|
||||
GET /api/onboarding/step/{n} # Get step data
|
||||
POST /api/onboarding/step/{n}/complete # Complete step
|
||||
POST /api/onboarding/step/{n}/skip # Skip step
|
||||
GET /api/onboarding/api-keys # Get API keys
|
||||
POST /api/onboarding/api-keys # Save API key
|
||||
GET /api/onboarding/resume # Get resume info
|
||||
# Autofill Endpoints
|
||||
GET /api/content-planning/enhanced-strategies/autofill/refresh/stream
|
||||
POST /api/content-planning/enhanced-strategies/autofill/refresh
|
||||
POST /api/content-planning/enhanced-strategies/{strategy_id}/autofill/accept
|
||||
|
||||
# Provider Information
|
||||
GET /api/onboarding/providers # Get all providers
|
||||
GET /api/onboarding/providers/{provider}/setup # Get setup info
|
||||
POST /api/onboarding/providers/{provider}/validate # Validate key
|
||||
GET /api/onboarding/validation/enhanced # Enhanced validation
|
||||
# AI Analytics Endpoints
|
||||
GET /api/content-planning/ai-analytics/
|
||||
POST /api/content-planning/ai-analytics/regenerate
|
||||
```
|
||||
|
||||
### **Component Logic Endpoints (15 Total)**
|
||||
### **Onboarding Endpoints**
|
||||
```python
|
||||
# AI Research Endpoints (4)
|
||||
POST /api/onboarding/ai-research/validate-user
|
||||
POST /api/onboarding/ai-research/configure-preferences
|
||||
POST /api/onboarding/ai-research/process-research
|
||||
GET /api/onboarding/ai-research/configuration-options
|
||||
# Core Onboarding
|
||||
GET /api/onboarding/status
|
||||
GET /api/onboarding/progress
|
||||
GET /api/onboarding/step/{n}
|
||||
POST /api/onboarding/step/{n}/complete
|
||||
POST /api/onboarding/step/{n}/skip
|
||||
|
||||
# Personalization Endpoints (6)
|
||||
POST /api/onboarding/personalization/validate-style
|
||||
POST /api/onboarding/personalization/configure-brand
|
||||
POST /api/onboarding/personalization/process-settings
|
||||
GET /api/onboarding/personalization/configuration-options
|
||||
POST /api/onboarding/personalization/generate-guidelines
|
||||
|
||||
# Research Utilities Endpoints (5)
|
||||
POST /api/onboarding/research/process-topic
|
||||
POST /api/onboarding/research/process-results
|
||||
POST /api/onboarding/research/validate-request
|
||||
GET /api/onboarding/research/providers-info
|
||||
POST /api/onboarding/research/generate-report
|
||||
# API Key Management
|
||||
GET /api/onboarding/api-keys
|
||||
POST /api/onboarding/api-keys
|
||||
GET /api/onboarding/providers
|
||||
GET /api/onboarding/providers/{provider}/setup
|
||||
POST /api/onboarding/providers/{provider}/validate
|
||||
```
|
||||
|
||||
### **API Documentation**
|
||||
@@ -218,6 +226,7 @@ POST /api/onboarding/research/generate-report
|
||||
1. Visit http://localhost:3000
|
||||
2. System checks onboarding status
|
||||
3. Shows main application directly
|
||||
4. Access Content Planning Dashboard for AI-powered strategy generation
|
||||
|
||||
---
|
||||
|
||||
@@ -227,28 +236,35 @@ POST /api/onboarding/research/generate-report
|
||||
|
||||
#### **Import Errors**
|
||||
```bash
|
||||
# If you get "No module named 'backend'" error:
|
||||
# Use the run_backend.py script from project root
|
||||
python run_backend.py
|
||||
# If you get import errors, ensure you're in the correct directory
|
||||
cd backend
|
||||
python -c "from api.content_planning.api.router import router; print('✅ Backend imports working')"
|
||||
```
|
||||
|
||||
#### **Missing Dependencies**
|
||||
```bash
|
||||
cd backend
|
||||
# Install all Python dependencies
|
||||
pip install -r requirements.txt
|
||||
|
||||
# If specific modules are missing
|
||||
pip install fastapi uvicorn sqlalchemy psycopg2-binary python-multipart
|
||||
```
|
||||
|
||||
#### **Port Already in Use**
|
||||
```bash
|
||||
# Find and kill process using port 8000
|
||||
lsof -ti:8000 | xargs kill -9
|
||||
|
||||
# Or use a different port
|
||||
python start_alwrity_backend.py --port 8001
|
||||
```
|
||||
|
||||
#### **Database Issues**
|
||||
```bash
|
||||
# Remove and recreate database
|
||||
rm backend/onboarding.db
|
||||
# Restart backend - database will be recreated automatically
|
||||
# The system uses SQLite by default
|
||||
# Database files are created automatically in the backend directory
|
||||
# Check for database files:
|
||||
ls backend/*.db
|
||||
```
|
||||
|
||||
### **Frontend Issues**
|
||||
@@ -272,22 +288,25 @@ npm start -- --port 3001
|
||||
- Check that frontend is making requests to correct backend URL
|
||||
- Verify proxy configuration in package.json
|
||||
|
||||
### **Component Logic Issues**
|
||||
### **Content Planning Issues**
|
||||
|
||||
#### **API Key Validation**
|
||||
#### **AI Autofill Not Working**
|
||||
```bash
|
||||
# Test API key validation
|
||||
curl -X POST http://localhost:8000/api/onboarding/providers/openai/validate \
|
||||
# Test the autofill endpoint directly
|
||||
curl -X POST http://localhost:8000/api/content-planning/enhanced-strategies/autofill/refresh \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"api_key": "sk-your-openai-key"}'
|
||||
-d '{"user_id": 1, "use_ai": true, "ai_only": true}'
|
||||
|
||||
# Check backend logs for AI service errors
|
||||
# Ensure API keys are configured correctly
|
||||
```
|
||||
|
||||
#### **Research Utilities**
|
||||
#### **Strategy Generation Issues**
|
||||
```bash
|
||||
# Test research topic processing
|
||||
curl -X POST http://localhost:8000/api/onboarding/research/process-topic \
|
||||
# Test strategy creation
|
||||
curl -X POST http://localhost:8000/api/content-planning/enhanced-strategies/ \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"topic": "AI writing tools", "providers": ["tavily"], "depth": "standard"}'
|
||||
-d '{"name": "Test Strategy", "user_id": 1}'
|
||||
```
|
||||
|
||||
---
|
||||
@@ -296,8 +315,8 @@ curl -X POST http://localhost:8000/api/onboarding/research/process-topic \
|
||||
|
||||
### **Backend Logs**
|
||||
- Check terminal where backend is running
|
||||
- Logs show API requests and errors
|
||||
- FastAPI provides detailed error messages
|
||||
- FastAPI provides detailed error messages and request logs
|
||||
- Look for AI service integration logs
|
||||
|
||||
### **Frontend Logs**
|
||||
- Check browser developer console
|
||||
@@ -305,7 +324,7 @@ curl -X POST http://localhost:8000/api/onboarding/research/process-topic \
|
||||
- Network tab for API requests
|
||||
|
||||
### **Database**
|
||||
- SQLite database: `backend/onboarding.db`
|
||||
- SQLite database files in backend directory
|
||||
- Created automatically on first run
|
||||
- Can be inspected with SQLite browser
|
||||
|
||||
@@ -322,7 +341,7 @@ curl -X POST http://localhost:8000/api/onboarding/research/process-topic \
|
||||
```bash
|
||||
# Build and run with gunicorn
|
||||
pip install gunicorn
|
||||
gunicorn main:app -w 4 -k uvicorn.workers.UvicornWorker
|
||||
gunicorn main:app -w 4 -k uvicorn.workers.UvicornWorker --bind 0.0.0.0:8000
|
||||
```
|
||||
|
||||
### **Frontend**
|
||||
@@ -335,39 +354,73 @@ npm run build
|
||||
### **Environment Variables**
|
||||
```bash
|
||||
# Backend environment variables
|
||||
export DATABASE_URL="sqlite:///./onboarding.db"
|
||||
export DATABASE_URL="postgresql://user:password@localhost/alwrity"
|
||||
export CORS_ORIGINS="http://localhost:3000,http://127.0.0.1:3000"
|
||||
export LOG_LEVEL="INFO"
|
||||
export OPENAI_API_KEY="your-openai-key"
|
||||
export GEMINI_API_KEY="your-gemini-key"
|
||||
|
||||
# Frontend environment variables
|
||||
export REACT_APP_API_URL="http://localhost:8000"
|
||||
export REACT_APP_ENVIRONMENT="development"
|
||||
export REACT_APP_ENVIRONMENT="production"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 **Key Features Available**
|
||||
|
||||
### **✅ Content Strategy Generation**
|
||||
- AI-powered content strategy generation with 100% success rate
|
||||
- 30+ strategic input fields with intelligent auto-fill
|
||||
- Real-time AI analysis and recommendations
|
||||
- Multi-category strategy organization
|
||||
|
||||
### **✅ Advanced AI Integration**
|
||||
- Multiple AI providers (OpenAI, Google Gemini, Anthropic)
|
||||
- Structured JSON output with retry mechanisms
|
||||
- Field type normalization and validation
|
||||
- Predictive analytics and optimization
|
||||
|
||||
### **✅ Modern Architecture**
|
||||
- FastAPI backend with modular services
|
||||
- React frontend with Material-UI
|
||||
- Multi-tenant authentication system
|
||||
- Comprehensive API documentation
|
||||
|
||||
### **✅ Development Tools**
|
||||
- Hot reload for both frontend and backend
|
||||
- Comprehensive error handling and logging
|
||||
- Interactive API documentation
|
||||
- Modular service architecture
|
||||
|
||||
---
|
||||
|
||||
## 📚 **Additional Documentation**
|
||||
|
||||
- **[API Documentation](API_DOCUMENTATION.md)** - Complete FastAPI backend documentation
|
||||
- **[Migration Guide](ALWRITY_MIGRATION_FINAL.md)** - Complete migration documentation
|
||||
- **[Enhanced Strategy Refactoring Plan](docs/enhanced_strategy_refactoring_plan.md)** - Module breakdown strategy
|
||||
- **[ALwrity Vision](ALwrity_vision.md)** - Comprehensive platform vision and roadmap
|
||||
- **[README.md](README.md)** - Main project documentation
|
||||
|
||||
---
|
||||
|
||||
## 🎉 **Setup Complete!**
|
||||
|
||||
**✅ The new ALwrity architecture is ready for development and testing.**
|
||||
**✅ The new ALwrity FastAPI + React architecture is ready for development and testing.**
|
||||
|
||||
**Key Features Available:**
|
||||
- **27 API Endpoints** with comprehensive functionality
|
||||
- **AI-Powered Content Strategy Generation** with 100% success rate
|
||||
- **Modular Backend Services** for maintainability and scalability
|
||||
- **Modern React Frontend** with Material-UI components
|
||||
- **Component Logic Services** for advanced features
|
||||
- **Design System** for consistent UI/UX
|
||||
- **Real-time Validation** and error handling
|
||||
- **Complete Onboarding Flow** with 6 steps
|
||||
- **Comprehensive API Documentation** with interactive testing
|
||||
- **Multi-tenant Authentication** system
|
||||
- **Advanced AI Integration** with multiple providers
|
||||
|
||||
**Next Steps:**
|
||||
1. **Test all endpoints** using the API documentation
|
||||
2. **Explore the React components** and design system
|
||||
3. **Configure API keys** for different providers
|
||||
4. **Start developing** new features using the established patterns
|
||||
1. **Test the content strategy generation** using the AI autofill feature
|
||||
2. **Explore the modular backend services** and API endpoints
|
||||
3. **Configure API keys** for different AI providers
|
||||
4. **Start developing** new features using the established patterns
|
||||
5. **Review the refactoring plan** for future module breakdown
|
||||
|
||||
**🚀 Ready to build the ultimate AI-powered digital marketing platform!**
|
||||
Reference in New Issue
Block a user