Welcome to the complete documentation for Artistry, an AI-powered interior design platform.
- Quick Start Guide - Get up and running in 5 minutes
- Installation Guide - Detailed installation instructions
- Configuration - Environment setup and configuration
- System Architecture - Complete system design
- Microservices Overview - Service details and interactions
- Technology Stack - Technologies and dependencies
- Database Schema - MongoDB structure
- Full Workflow Guide - Using the complete AI workflow
- Individual Services Guide - Using services separately
- Best Practices - Tips for optimal results
- Gateway API - API orchestration endpoints
- Detect Service API - Object detection endpoints
- Segment Service API - Image segmentation endpoints
- Advise Service API - Design advice endpoints
- Generate Service API - Image generation endpoints
- Development Guide - Local development setup
- Contributing Guide - How to contribute
- Testing Guide - Running tests
- Adding New Services - Creating microservices
- Common Issues - Solutions to frequent problems
- Backend Debugging - Backend troubleshooting
- Frontend Debugging - Frontend troubleshooting
- Performance Optimization - Speed and efficiency tips
- Deployment Guide - Production deployment
- Docker Guide - Container deployment
- Cloud Deployment - AWS, GCP, Azure
- FAQ - Frequently asked questions
- Glossary - Terms and definitions
- Changelog - Version history
- Roadmap - Future plans
- Main README - Project overview
- Backend Documentation - Backend details
- Frontend Documentation - Frontend details
- Interactive API Docs - Swagger UI (when running)
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: kush2012bhardwaj@gmail.com
Found an error or want to improve the docs? Contributions are welcome!
- Fork the repository
- Edit documentation files
- Submit a pull request
Please follow our Contributing Guide.
Last Updated: November 22, 2025
Version: 2.0