A modern, client-side application that transforms simple app descriptions into comprehensive, structured documentation using AI. Built with Next.js and designed with a developer-focused interface.
- Transform simple app ideas into detailed project documentation
- Uses DeepSeek API by default (configurable to other providers)
- Generates "English-to-React compilation ready" documentation
- Structured output with proper file organization and linking syntax
- Clean, professional UI inspired by bolt.new and v0.dev
- Dark/light theme support with proper contrast ratios
- Responsive design with collapsible sidebar
- Real-time progress animations during generation
- Download complete project documentation as ZIP files
- Individual file downloads with proper formatting
- File preview with syntax highlighting
- Project structure visualization
- Client-side storage for API keys and settings
- Recent projects history
- Auto-save functionality
- Import/export settings
- Multiple AI provider support (DeepSeek, OpenAI, etc.)
- Customizable generation parameters (temperature, max tokens)
- Custom system prompts
- API key management with security features
- Node.js 18+
- An API key from DeepSeek (or your preferred AI provider)
-
Clone or download the project
-
Install dependencies:
npm install
-
Start the development server:
npm run dev
-
Open http://localhost:3000 in your browser
- Click the Settings icon in the top-right corner
- Add your API key in the "API Configuration" tab
- Optionally customize generation parameters and preferences
- Save settings - they're stored locally in your browser
-
Describe Your App: Enter a simple description of your app idea in the textarea
Example: "Create a todo app with user authentication, task categories, and real-time collaboration" -
Generate: Click "Generate Docs" to start the AI documentation process
-
Review: Watch the progress animation and review the generated documentation structure
-
Download: Export individual files or download the complete project as a ZIP
Use the sidebar templates for quick starts:
- React App: Full-featured React application template
- Dashboard: Analytics dashboard with charts and user management
- Landing Page: SaaS product landing page template
- New Project: Click "New Project" to start fresh without losing current work
- Recent Projects: Access previously generated projects from the sidebar
- File Preview: View generated files with proper syntax highlighting
- Settings Export: Backup and share your configuration settings
The AI generates documentation following the "English-to-React compilation format":
- Project Overview: Main README and project structure
- Page Documentation: Detailed specifications for each page/route
- Component Documentation: Reusable component specifications
- Layout Documentation: Layout and navigation structure
- Configuration Files: Package.json, environment setup, etc.
Each file includes:
- Detailed descriptions and specifications
- Component linking syntax
[[ComponentName]] - Props and state management details
- Styling and behavior specifications
- Integration requirements
- Framework: Next.js 14+ with App Router
- Styling: Tailwind CSS v4 with custom design tokens
- UI Components: shadcn/ui component library
- AI Integration: Configurable AI providers (DeepSeek default)
- File Management: JSZip for download functionality
- Storage: Browser localStorage for client-side persistence
- Theme: next-themes for dark/light mode support
- Cost-effective and high-quality documentation generation
- Fast response times
- Good understanding of development patterns
- GPT-4 and GPT-3.5 support
- Excellent code understanding
- Higher cost but premium quality
- Easily configurable for other AI providers
- Extensible architecture for future integrations
All data is stored locally in your browser:
- API Keys: Securely stored (never transmitted except to AI providers)
- Settings: Generation preferences and configuration
- Projects: Recent project history and documentation
- Themes: UI preferences and customizations
This is a client-side application with no backend dependencies. To contribute:
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly in both light and dark modes
- Submit a pull request
- API keys are stored locally and never transmitted to third parties
- All AI requests go directly from your browser to the configured provider
- No server-side storage or logging of your data
- Client-side only architecture ensures privacy
MIT License - feel free to use this project for personal or commercial purposes.
For issues or questions:
- Check the settings configuration
- Verify your API key is valid
- Try refreshing the page to reset local storage
- Check browser console for detailed error messages