Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/samybaxy/simone-ai/archive/refs/heads/main.zipSimulation One (simone-ai)
A modern AI-powered chatbot plugin for WordPress that provides an intelligent conversational interface with seamless WordPress integration and social login support.
🚀 Features
Current Features (Phase 1)
-
🔐 Advanced Authentication System
- WordPress user integration
- Email/username login support
- Social login (Google, with Facebook & Twitter ready)
- Secure token-based authentication
- Session management with 24-hour expiration
-
💾 Robust Database Architecture
- Chat session tracking
- Message history storage
- User preference management
- Optimized database queries
-
🛡️ REST API Infrastructure
- Modern RESTful endpoints
- WordPress nonce security
- Input sanitization and validation
- Comprehensive error handling
-
🎨 Modern Design System
- Dark-themed UI matching modern aesthetics
- SCSS-based styling with CSS variables
- Responsive design ready
- Accessibility-focused components
Upcoming Features
- React-based chat interface
- Real-time messaging with WebSocket support
- GraphQL integration for AI/LLM connectivity
- WooCommerce order tracking integration
- Voice input capabilities
- Multi-language support
📋 Requirements
- WordPress 6.0 or higher
- PHP 8.2 or higher
- MySQL 5.7+ or MariaDB 10.3+
- Node.js 18+ and npm 8+ (for development)
🔧 Installation
Deployment via GitHub Actions
Note: This plugin is designed for deployment via GitHub Actions to WP Engine. Dependencies are automatically installed during the CI/CD process.
Production Deployment
This plugin is designed to be deployed via GitHub Actions to WP Engine. Push your changes to the staging branch to trigger automatic deployment:
git push origin staging
The GitHub Actions workflow will:
- Install Node.js dependencies
- Build production assets
- Deploy to WP Engine staging environment
- Run post-deployment scripts
Manual Installation (For Development/Testing)
-
Clone the repository into your WordPress plugins directory:
cd wp-content/plugins git clone https://github.com/samybaxy/simone-ai.git -
Install dependencies manually:
cd simone-ai composer install --no-dev --optimize-autoloader npm install npm run build -
Activate the plugin through the WordPress admin panel
For Development
-
Clone the repository:
git clone https://github.com/samybaxy/simone-ai.git cd simone-ai -
Install dependencies:
composer install npm install -
Start the development server:
npm start -
(Optional) Use wp-env for local development:
npm run wp-env start
🏗️ Architecture
Plugin Structure
simone-ai/
├── includes/ # PHP classes
│ ├── class-simone-ai.php # Main plugin class
│ ├── class-auth.php # Authentication handler
│ ├── class-database.php # Database operations
│ ├── class-rest-api.php # REST API endpoints
│ └── class-graphql-client.php # GraphQL client (coming soon)
├── src/ # JavaScript source files
│ ├── blocks/ # Gutenberg blocks
│ ├── components/ # React components
│ ├── hooks/ # Custom React hooks
│ ├── utils/ # Utility functions
│ └── styles/ # SCSS styles
├── build/ # Compiled assets (gitignored)
└── languages/ # Translation files
Database Schema
Chat Sessions Table (wp_simone_ai_chat_sessions):
id: Session identifieruser_id: WordPress user IDsession_token: Unique session tokentitle: Session titlestatus: active, archived, or deletedcreated_at,updated_at: Timestamps
Chat Messages Table (wp_simone_ai_chat_messages):
id: Message identifiersession_id: Related sessionmessage_type: user, assistant, or systemcontent: Message contentmetadata: Additional message data (JSON)created_at: Timestamp
🔌 API Reference
Authentication Endpoints
Login
POST /wp-json/simone-ai/v1/auth/login
Content-Type: application/json
{
"username": "user@example.com",
"password": "password123"
}
Social Login
POST /wp-json/simone-ai/v1/auth/social
Content-Type: application/json
{
"provider": "google",
"token": "google-auth-token"
}
Verify Authentication
GET /wp-json/simone-ai/v1/auth/verify
Chat Endpoints
Create Session
POST /wp-json/simone-ai/v1/chat/sessions
Send Message
POST /wp-json/simone-ai/v1/chat/messages
Content-Type: application/json
{
"session_id": 123,
"message": "Hello, how can you help me?"
}
🛠️ Development
Available Scripts
npm start- Start development server with hot reloadnpm run build- Build production assetsnpm run lint:js- Lint JavaScript filesnpm run lint:css- Lint SCSS filesnpm run format- Format code with Prettiercomposer lint- Lint PHP filescomposer lint:fix- Fix PHP coding standards
Coding Standards
This project follows:
- WordPress Coding Standards for PHP
- WordPress ESLint config for JavaScript
- WordPress Prettier config for formatting
- SCSS for styling with BEM methodology
Testing
# PHP Unit Tests
composer test
# JavaScript Tests
npm test
# E2E Tests
npm run test:e2e
🤝 Contributing
We welcome contributions! Please see our Contributing Guidelines for details.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
📄 License
This project is licensed under the GPL v2 or later - see the LICENSE file for details.
🙏 Credits
Developed by the Simulation One Team
Third-party Libraries
🚀 Deployment
GitHub Actions Workflow
The plugin uses GitHub Actions for automated deployment to WP Engine:
- Trigger: Push to
stagingbranch - Build Process: Node.js dependencies → Build assets → Deploy
- Target Environment: WP Engine staging (
biolimitlesstg) - Post-deployment: Composer install (production only)
Manual Deployment Steps
- Push changes to staging branch
- GitHub Actions automatically builds and deploys
- Verify deployment on staging environment
- Promote to production when ready
📞 Support
- Documentation: [Coming Soon]
- Issues: GitHub Issues
- Email: support@simulationone.com
Made with ❤️ by Simulation One Team