Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .firebaserc
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"projects": {
"default": "flutterflow-docs-82026"
}
"default": "dreamflow-docs-2c50c",
"prod": "dreamflow-docs-2c50c",
"dreamflow-docs": "dreamflow-docs-2c50c"
},
"targets": {},
"etags": {}
}
82 changes: 81 additions & 1 deletion docs/get-started/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,89 @@
---
slug: /quickstart
title: Quickstart
description: Get started with Dreamflow by building your first app in just 4 minutes using AI-powered prompts and natural language descriptions.
tags: [quickstart, getting started, tutorial, ai, flutter, mobile app development]
sidebar_position: 1
keywords: [quickstart, getting started, dreamflow tutorial, ai app generation, flutter development, mobile app creation, natural language prompts]
---



# Quickstart

## Start With a Prompt (4 mins)

## Start from Scratch

Starting a new Flutter project in Dreamflow is simple and flexible. When you create a project from scratch, you'll begin with Flutter's classic counter app template. From there, you have multiple ways to build out your application:

- Use the **[AI Agent](../workspace/agent-panel.md)** to add features through natural language conversations.
- Visually construct your UI with the **[Properties Editor](../workspace/properties-panel.md)** and drag-and-drop tools.
- Write and edit code directly in the integrated **[Code Editor](../workspace/content-panel.md#code-editor)**.
- Combine these approaches seamlessly as your project grows.

This flexibility allows you to work in whatever way best suits your development style and project needs.

<div style={{
position: 'relative',
paddingBottom: 'calc(56.67989417989418% + 41px)', // Ensures the aspect ratio plus additional padding
height: 0,
width: '100%'
}}>
<iframe
src="https://demo.arcade.software/81iL80OjQC1gthaDKvPG?embed&show_copy_link=true"
title="Projects - FlutterFlow"
style={{
position: 'absolute',
top: 0,
left: 0,
width: '100%',
height: '100%',
colorScheme: 'light'
}}
frameBorder="0"
loading="lazy"
webkitAllowFullScreen
mozAllowFullScreen
allowFullScreen
allow="clipboard-write">
</iframe>
</div>

## Start from a Template

Dreamflow also provides a collection of professionally designed, production-ready templates to jumpstart your app development. Our templates are fully customizable to match your brand and requirements while being designed to work seamlessly across mobile, tablet, and web platforms.

Simply choose a template that matches your needs and customize it to create your unique application.

<div style={{
position: 'relative',
paddingBottom: 'calc(56.67989417989418% + 41px)', // Ensures the aspect ratio plus additional padding
height: 0,
width: '100%'
}}>
<iframe
src="https://demo.arcade.software/VUOZqYhw1r4Ea4jBQyJq?embed&show_copy_link=true"
title="Projects - FlutterFlow"
style={{
position: 'absolute',
top: 0,
left: 0,
width: '100%',
height: '100%',
colorScheme: 'light'
}}
frameBorder="0"
loading="lazy"
webkitAllowFullScreen
mozAllowFullScreen
allowFullScreen
allow="clipboard-write">
</iframe>
</div>



## Start With a Prompt

Dreamflow's AI-powered app generation allows you to create fully functional, production-ready applications from simple text or image descriptions. Simply describe what you want to build, and Dreamflow Agent will generate the entire app structure, UI components, and functionality for you.

Expand Down
40 changes: 0 additions & 40 deletions docs/get-started/welcome.md

This file was deleted.

220 changes: 91 additions & 129 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,159 +1,121 @@
---
title: Getting Started
custom_edit_url: null
showLastUpdateTime: false
hide_title: true
slug: /
hide_table_of_contents: false
title: Welcome to Dreamflow
description: Discover Dreamflow, the AI-first platform for building mobile apps with Flutter. Learn about key features, how it works, and get started with your first app.
tags: [welcome, introduction, overview, dreamflow, flutter, mobile app development, ai]
sidebar_position: 0
keywords: [dreamflow welcome, flutter development platform, ai mobile app development, visual development environment, flutter builder, mobile app creation]
---

import InfoCard from '@site/src/components/InfoCard';
import InfoCards from '@site/src/components/InfoCards';
import FlutterFlowDocsLogo from '@site/src/components/FlutterFlowDocsLogo';
import FlutterFlowLogo from '@site/src/components/FlutterFlowLogo';
import GearIcon from '@site/static/icons/_icon_Setting.png';
import DocsIcon from '@site/static/icons/document.png';
import DeviceIcon from '@site/static/icons/deviceMobile.png';
import CheckIcon from '@site/static/icons/check_errors.png';
import UsersIcon from '@site/static/icons/users.png';
import BranchIcon from '@site/static/icons/branch_New.png';

# Welcome to Dreamflow

**The Fastest Way to Build Mobile Apps**

Dreamflow is an AI-first platform that combines code, visual, and agentic app development for Flutter—no install, no lock-in, production-ready workflows. Transform your ideas into production-ready mobile apps in minutes using natural language prompts and our integrated development environment.

# Getting Started with Dreamflow
Dreamflow is a visual development environment that lets you build mobile, web, and desktop apps incredibly fast, without sacrificing on app quality or features.
### Product Tour

<div style={{
position: 'relative',
paddingBottom: '56.25%', // 16:9 aspect ratio
height: 0,
width: '100%',
marginBottom: '2rem'
}}>
<iframe
src="https://www.youtube.com/embed/aT8Ta0-h_Ak"
title="Dreamflow Platform Demo"
style={{
position: 'absolute',
top: 0,
left: 0,
width: '100%',
height: '100%'
}}
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen>
</iframe>
</div>


<InfoCards>
<InfoCard
icon="🚀"
title="Build Your First App"
description="Get started with Dreamflow by building your first Dreamflow app step-by-step."
pagePath="/quickstart"
isLarge={true}
/>
<InfoCard
icon="🗺️"
title="App Development Roadmap"
description="Learn the three essential layers of app development: UI Layer, Logic Layer, and Data Layer for building Dreamflow applications."
pagePath="/roadmap"
isLarge={true}
/>

</InfoCards>

<p></p>


<p></p>
## Key Features

### Dreamflow Tour
- **[AI Agent](workspace/agent-panel.md)**: Prompt small edits or large refactors with natural language commands. The AI agent can scaffold entire screens, implement complex flows, and generate comprehensive tests, making development faster and more intuitive than traditional coding approaches.

<InfoCards>
- **[Realtime Preview](workspace/content-panel.md#app-preview)**: See your changes instantly with a live run session that compiles and previews your app in real-time. Inspect logs, monitor state changes, and debug issues as they happen, providing immediate feedback for faster iteration and development.

<InfoCard
icon="🏗️"
title="Dreamflow Builder"
description="Explore the Dreamflow Builder interface, learn about the dashboard, widgets panel, and how to navigate the visual development environment."
pagePath="/flutterflow-ui/dashboard"
isLarge={true}
/>

<InfoCard
icon="🔍"
title="Building Blocks"
description="Dive into the building blocks of the platform: projects, widgets, functions and more."
pagePath="/resources"
isLarge = {true}
/>
- **[Visual Widget Tree](workspace/modules-panel/widget-panel.md)**: Add, remove, move, wrap, collapse, and expand UI components with intuitive visual controls. Restructure your entire widget hierarchy instantly through drag-and-drop interactions, making UI development more visual and accessible.

- **[Properties Editor](workspace/properties-panel.md)**: Type-safe controls for every widget property with intelligent suggestions and validation. Use expressions, formulas, or simply ask the AI for assistance when configuring complex widget behaviors and styling.

</InfoCards>
- **Deploy**: Push your applications to the web or app stores with streamlined one-click deployment. Support for multiple platforms including Web, iOS, Android, macOS, Windows, and Linux ensures your app reaches users everywhere.

<p></p>
- **Hot Reload**: See changes instantly as you develop with Flutter's hot reload technology, enabling rapid iteration and real-time feedback during the development process.

<div class="video-container"><iframe src="https://www.youtube.com/embed/GpXjU-ieAKU?si=moIEUUGry24CdSJN" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></div>
- **Debug Console**: Monitor app logs and performance in real-time with integrated debugging tools that help you identify and resolve issues quickly.


- **Multi-Platform Support**: Build applications that run seamlessly across mobile (iOS and Android), web (responsive), and desktop (macOS, Windows, Linux) platforms from a single codebase.

## How It Works

Dreamflow follows a simple 3-step workflow: **Start → Build → Run & Ship**

### 1. Start
Kick off from a natural-language prompt, a blank Flutter project, or import an existing repo (coming soon).

### Best Practices
### 2. Build
Jump between multiple development modes to build your app efficiently:

Essential guidelines and recommendations for building robust Dreamflow applications. Discover security best practices and performance optimization techniques to ensure your apps are production-ready, scalable, and maintainable.
- Use the **Code** editor for direct Flutter development.
- Navigate the **Visual widget tree** for drag-and-drop UI building.
- Configure components in the **Properties editor** with type-safe controls.
- Leverage the **AI agent** to scaffold features and refactor code through natural language.

<InfoCards>
<InfoCard
icon="🔐"
title="Secure your API Key"
description="Learn best practices for keeping your API keys created in Google Cloud Console safe and secure in production applications."
pagePath="/best-practices/secure-api-keys"
isLarge={true}
/>
<InfoCard
icon="🧪"
title="Test Your Apps Locally"
description="Set up Local Run to debug and validate your app in physical devices."
pagePath="/testing/local-run"
/>
<InfoCard
icon="📝"
title="Naming Variables"
description="Learn Dreamflow naming conventions and best practices for variables, functions, and components to maintain clean, readable code."
pagePath="/resources/style-guide"
/>
</InfoCards>
Built-in Firebase and Supabase integrations provide authentication, database, and storage capabilities without complex setup. The integrated **Language Server Protocol (LSP)** delivers intelligent code completions, quick fixes, and real-time diagnostics as you type.

<div style={{
position: 'relative',
paddingBottom: 'calc(56.67989417989418% + 41px)', // Ensures the aspect ratio plus additional padding
height: 0,
width: '100%'
}}>
<iframe
src="https://demo.arcade.software/pkh6dsSwozFhyAZUW9IU?embed&show_copy_link=true"
title="Dreamflow App Creation Demo"
style={{
position: 'absolute',
top: 0,
left: 0,
width: '100%',
height: '100%',
colorScheme: 'light'
}}
frameBorder="0"
loading="lazy"
webkitAllowFullScreen
mozAllowFullScreen
allowFullScreen
allow="clipboard-write">
</iframe>
</div>

### 3. Run & Ship
A managed run session compiles and previews your app in real time. Connect Firebase/Supabase, test flows, and deploy to web or the app stores when ready.



## Ready to Start Building?

Whether you're a seasoned developer looking to accelerate your workflow or a newcomer wanting to bring your app ideas to life, Dreamflow provides the tools and AI assistance you need to succeed.

**Next Steps:**
1. **[Quickstart Guide](get-started/quickstart.md)**: Build your first app from scratch, from a template or describe your app idea and let AI generate an app for you.
2. **[Workspace Tour](workspace/workspace.md)**: Learn about the development environment.
3. **[Deployment Guide](test-and-publish/publish/web-deployment.md)**: Publish your app to the world.

### Scaling Dreamflow Apps

Learn advanced techniques and strategies to scale your Dreamflow applications from simple prototypes to enterprise-grade solutions with native integrations and modular architecture.

<InfoCards>
<InfoCard
icon="🔌"
title="Integrating Native Plugins in Dreamflow"
description="Extend Dreamflow's capabilities by integrating native platform plugins and custom functionality using method channels for advanced app development."
pagePath="/concepts/advanced/method-channels"
isLarge={true}
/>
<InfoCard
icon="🏗️"
title="Building Super Apps using Libraries"
description="Discover how to create scalable, modular applications using Dreamflow libraries to build complex, maintainable super apps with independent feature libraries."
pagePath="https://blog.flutterflow.io/scaling-super-apps-modular-architecture-with-flutterflow-libraries/"
/>

</InfoCards>

### Additional Tools

Discover additional tools and references to enhance your Dreamflow development experience:
<InfoCards>
<InfoCard
icon="⚙️"
title="System Requirements"
description="Ensure you meet system requirements required to smoothly run Dreamflow application on the web & desktop."
pagePath="/before-you-begin/setup-flutterflow"
/>
<InfoCard
icon="🆕"
title="What's New in Dreamflow"
description="Follow latest updates, features, and the latest enhancements in Dreamflow."
pagePath="https://community.flutterflow.io/c/whats-new-in-flutterflow"
/>

</InfoCards>

## Still Have Problems?

<!-- If you're still experiencing issues or need additional help, here are some resources to get you back on track:

- **[Submit Bug Report](#)** - Report bugs or issues you've encountered
- **[Community Forum](https://community.flutterflow.io)** - Ask questions and get help from the community
- **[Reddit Community](https://www.reddit.com/r/FlutterFlow/)** - Join discussions on Reddit
- **[Documentation Bug](https://github.com/FlutterFlow/flutterflow-documentation/issues)** - Report documentation issues
- **[Contribute to Documentation](https://github.com/FlutterFlow/flutterflow-documentation?tab=readme-ov-file#how-to-contribute)** - Contribution guidelines for contributing to the FlutterFlow documentation site.
- **[FlutterFlow Support](mailto:[email protected])** - Get direct support from the FlutterFlow support team. -->
Loading