Leon4gr45/builder
0
1# OSW Studio Documentation2 3**Your guide to building websites with AI.**4 5Welcome to OSW Studio - a browser-based development environment where you chat with AI to build websites and web apps.6 7---8 9## Quick Links10 11**New to OSW Studio?**12- ๐ **[Overview](?doc=overview)** - What is OSW Studio? (1 min read)13- ๐ **[Getting Started](?doc=getting-started)** - Build your first site (5 min)14 15**Common Tasks:**16- ๐พ [Manage Projects](?doc=projects)17- ๐ค [Work with AI](?doc=working-with-ai)18- ๐ [Deploy Your Site](?doc=deploying-sites)19 20**Features:**21- ๐ฆ [Templates](?doc=templates) - Start faster22- โก [Skills](?doc=skills) - Teach AI your preferences23 24**Need Help?**25- โ [FAQ](?doc=faq)26- ๐ง [Troubleshooting](?doc=troubleshooting)27 28---29 30## Documentation Structure31 32### Getting Started33 34Perfect for newcomers and casual users:35 36- **[Overview](?doc=overview)** - What is OSW Studio and who is it for?37- **[Getting Started](?doc=getting-started)** - Set up and create your first project38- **[Projects](?doc=projects)** - Create, manage, and export projects39 40### Using OSW Studio41 42Guides for regular users:43 44- **[Working with AI](?doc=working-with-ai)** - Chat vs Code modes, prompting tips45- **[Templates](?doc=templates)** - Use and create project templates46- **[Skills](?doc=skills)** - Teach AI your workflow preferences47- **[Deploying Your Sites](?doc=deploying-sites)** - Deploy to Vercel, Netlify, etc.48 49### Help & Advanced50 51For support and self-hosters:52 53- **[FAQ](?doc=faq)** - Common questions answered54- **[Troubleshooting](?doc=troubleshooting)** - Fix common issues55- **[Server Mode](?doc=server-mode)** - Self-hosting and deployment56- **[Multitenancy](?doc=multitenancy)** - Workspaces, users, roles, quotas (Server Mode)57- **[Deployment Publishing](?doc=site-publishing)** - Analytics, SEO, compliance (Server Mode)58- **[Custom Domains](?doc=custom-domains)** - Use your own domain for published sites (Server Mode)59- **[Backend](?doc=backend-features)** - Database, API endpoints, secrets (Server Mode)60 61---62 63## What Can I Build?64 65OSW Studio supports multiple project runtimes โ pick the one that fits your needs:66 67**Static (HTML/CSS/JS):**68โ
**Personal websites** - Portfolios, blogs, resumes69โ
**Landing pages** - Marketing sites, product pages70โ
**Documentation sites** - Project docs, help centers71โ
**Interactive apps** - Calculators, tools, games (client-side)72 73**React, Preact, Svelte, Vue:**74โ
**Component-based apps** - Dashboards, admin panels, SPAs75โ
**Interactive UIs** - Forms, data visualization, real-time interfaces76โ
**npm ecosystem** - Import packages by name, fetched from CDN at runtime77โ
**Single-file components** - Svelte `.svelte` and Vue `.vue` files compiled in-browser78 79**Python & Lua:**80โ
**Scripts and algorithms** - Run Python (via Pyodide) and Lua (via wasmoon) in an interactive Console81โ
**Data processing** - Experiment with code without leaving the browser82โ
**Learning environment** - Try language features with instant feedback83 84**Server Mode adds:**85โ
**Workspaces** - Isolated environments for teams, clients, or projects86โ
**Multi-user** - User accounts with shared workspace access87โ
**API endpoints** - REST APIs with database access via edge functions88โ
**Dynamic sites** - Store and retrieve data with SQLite databases89 90---91 92## Key Concepts93 94### Chat with AI to Build95 96Describe what you want in plain English. AI writes the code, creates files, and explains what it's doing.97 98```99Create a portfolio website with a hero section,100about section, and project gallery101```102 103### Two Modes104 105**๐ฌ Chat Mode** - Ask questions, plan, explore (read-only)106**๐ง Code Mode** - AI builds and modifies your project107 108### Live Preview109 110See your website update in real-time as AI builds it.111 112### Export & Deploy113 114Download your complete site and deploy to Vercel, Netlify, or any static host in minutes.115 116---117 118## Resources119 120### External Links121 122- **[Live Demo](https://huggingface.co/spaces/otst/osw-studio)** - Try OSW Studio now123- **[GitHub Repository](https://github.com/o-stahl/osw-studio)** - Source code124- **[Report Issues](https://github.com/o-stahl/osw-studio/issues)** - Bug reports & feature requests125 126### Features127 128**Major Features:**129- Multiple project runtimes (Static, Handlebars, React, Preact, Svelte, Vue, Python, Lua)130- Multi-provider AI support (14+ providers, including ChatGPT subscription and HuggingFace free tier)131- Dual modes (Chat/Code)132- Semantic blocks โ drag pre-defined layouts onto the preview133- Templates & Skills systems134- Browser mode (IndexedDB) and Desktop app (macOS/Windows/Linux)135- Optional Server mode with workspaces and multi-user support136- Site publishing with SEO & analytics137- Edge functions & database management138- Cost tracking139 140---141 142## Getting Help143 144**Before asking for help:**145 1461. Check the [FAQ](?doc=faq)1472. Search [GitHub Issues](https://github.com/o-stahl/osw-studio/issues)1483. Review [Troubleshooting](?doc=troubleshooting)149 150**Still stuck?**151 152Create an issue on GitHub with:153- What you're trying to do154- What's happening instead155- Steps to reproduce156- Browser and OS version157- Screenshots if relevant158 159---160 161**Ready to start?** โ **[Get Started](?doc=getting-started)**162 