Spaces:
Running
OSW Studio Documentation
Your guide to building websites with AI.
Welcome to OSW Studio - a browser-based development environment where you chat with AI to build websites and web apps.
Quick Links
New to OSW Studio?
- π Overview - What is OSW Studio? (1 min read)
- π Getting Started - Build your first site (5 min)
Common Tasks:
- πΎ Manage Projects
- π€ Work with AI
- π Deploy Your Site
Features:
Need Help?
- β FAQ
- π§ Troubleshooting
Documentation Structure
Getting Started
Perfect for newcomers and casual users:
- Overview - What is OSW Studio and who is it for?
- Getting Started - Set up and create your first project
- Projects - Create, manage, and export projects
Using OSW Studio
Guides for regular users:
- Working with AI - Chat vs Code modes, prompting tips
- Templates - Use and create project templates
- Skills - Teach AI your workflow preferences
- Deploying Your Sites - Deploy to Vercel, Netlify, etc.
Help & Advanced
For support and self-hosters:
- FAQ - Common questions answered
- Troubleshooting - Fix common issues
- Server Mode - Self-hosting and deployment
- Multitenancy - Workspaces, users, roles, quotas (Server Mode)
- Deployment Publishing - Analytics, SEO, compliance (Server Mode)
- Backend - Database, API endpoints, secrets (Server Mode)
What Can I Build?
OSW Studio supports multiple project runtimes β pick the one that fits your needs:
Static (HTML/CSS/JS): β Personal websites - Portfolios, blogs, resumes β Landing pages - Marketing sites, product pages β Documentation sites - Project docs, help centers β Interactive apps - Calculators, tools, games (client-side)
React, Preact, Svelte, Vue:
β
Component-based apps - Dashboards, admin panels, SPAs
β
Interactive UIs - Forms, data visualization, real-time interfaces
β
npm ecosystem - Import packages by name, fetched from CDN at runtime
β
Single-file components - Svelte .svelte and Vue .vue files compiled in-browser
Python & Lua: β Scripts and algorithms - Run Python (via Pyodide) and Lua (via wasmoon) in an interactive Console β Data processing - Experiment with code without leaving the browser β Learning environment - Try language features with instant feedback
Server Mode adds: β Workspaces - Isolated environments for teams, clients, or projects β Multi-user - User accounts with shared workspace access β API endpoints - REST APIs with database access via edge functions β Dynamic sites - Store and retrieve data with SQLite databases
Key Concepts
Chat with AI to Build
Describe what you want in plain English. AI writes the code, creates files, and explains what it's doing.
Create a portfolio website with a hero section,
about section, and project gallery
Two Modes
π¬ Chat Mode - Ask questions, plan, explore (read-only) π§ Code Mode - AI builds and modifies your project
Live Preview
See your website update in real-time as AI builds it.
Export & Deploy
Download your complete site and deploy to Vercel, Netlify, or any static host in minutes.
Resources
External Links
- Live Demo - Try OSW Studio now
- GitHub Repository - Source code
- Report Issues - Bug reports & feature requests
Features
Major Features:
- Multiple project runtimes (Static, Handlebars, React, Preact, Svelte, Vue, Python, Lua)
- Multi-provider AI support (14+ providers, including ChatGPT subscription and HuggingFace free tier)
- Dual modes (Chat/Code)
- Semantic blocks β drag pre-defined layouts onto the preview
- Templates & Skills systems
- Browser mode (IndexedDB) and Desktop app (macOS/Windows/Linux)
- Optional Server mode with workspaces and multi-user support
- Site publishing with SEO & analytics
- Edge functions & database management
- Cost tracking
Getting Help
Before asking for help:
- Check the FAQ
- Search GitHub Issues
- Review Troubleshooting
Still stuck?
Create an issue on GitHub with:
- What you're trying to do
- What's happening instead
- Steps to reproduce
- Browser and OS version
- Screenshots if relevant
Ready to start? β Get Started