diff --git a/README.md b/README.md index c558183b1..29410e484 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,18 @@ A template for building your own workflow automation platform. Built on top of W ![Workflow Builder Screenshot](screenshot.png) +## Deploy Your Own + +You can deploy your own version of the workflow builder to Vercel with one click: + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fworkflow-builder-template&project-name=workflow-builder&repository-name=workflow-builder&demo-title=Workflow%20Builder&demo-description=A%20free%2C%20open-source%20template%20for%20building%20visual%20workflow%20automation%20platforms%20with%20real%20integrations%20and%20code%20generation&demo-url=https%3A%2F%2Fworkflow-builder-template.vercel.app&demo-image=https%3A%2F%2Fraw.githubusercontent.com%2Fvercel-labs%2Fworkflow-builder-template%2Fmain%2Fscreenshot.png&env=BETTER_AUTH_SECRET,INTEGRATION_ENCRYPTION_KEY,AI_GATEWAY_API_KEY&envDescription=BETTER_AUTH_SECRET+and+INTEGRATION_ENCRYPTION_KEY+are+required+secrets.+AI_GATEWAY_API_KEY+is+optional.&stores=%5B%7B%22type%22%3A%22postgres%22%7D%5D) + +**What happens during deployment:** + +- **Automatic Database Setup**: A Neon Postgres database is automatically created and connected to your project +- **Environment Configuration**: You'll be prompted to provide required environment variables (Better Auth credentials and AI Gateway API key) +- **Ready to Use**: After deployment, you can start building workflows immediately + ## What's Included - **Visual Workflow Builder** - Drag-and-drop interface powered by React Flow @@ -71,14 +83,6 @@ Visit [http://localhost:3000](http://localhost:3000) to get started. - **Database Query** - Query or update PostgreSQL - **HTTP Request** - Call external APIs -### Condition Nodes - -- Conditional branching based on data - -### Transform Nodes - -- Data transformation and mapping - ## Code Generation Workflows can be converted to executable TypeScript code with the `"use workflow"` directive: diff --git a/lib/constants.ts b/lib/constants.ts index b83fc0f8f..21d538d54 100644 --- a/lib/constants.ts +++ b/lib/constants.ts @@ -1,6 +1,6 @@ // Vercel deployment configuration export const VERCEL_DEPLOY_URL = - "https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fworkflow-builder-template&env=DATABASE_URL,BETTER_AUTH_SECRET,BETTER_AUTH_URL,VERCEL_API_TOKEN,OPENAI_API_KEY&envDescription=Required+environment+variables+for+workflow-builder-template.+See+README+for+details.&stores=%5B%7B%22type%22%3A%22postgres%22%7D%5D&project-name=workflow-builder-template&repository-name=workflow-builder-template"; + "https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fworkflow-builder-template&project-name=workflow-builder&repository-name=workflow-builder&demo-title=Workflow%20Builder&demo-description=A%20free%2C%20open-source%20template%20for%20building%20visual%20workflow%20automation%20platforms%20with%20real%20integrations%20and%20code%20generation&demo-url=https%3A%2F%2Fworkflow-builder-template.vercel.app&demo-image=https%3A%2F%2Fraw.githubusercontent.com%2Fvercel-labs%2Fworkflow-builder-template%2Fmain%2Fscreenshot.png&env=BETTER_AUTH_SECRET,INTEGRATION_ENCRYPTION_KEY,AI_GATEWAY_API_KEY&envDescription=BETTER_AUTH_SECRET+and+INTEGRATION_ENCRYPTION_KEY+are+required+secrets.+AI_GATEWAY_API_KEY+is+optional.&stores=%5B%7B%22type%22%3A%22postgres%22%7D%5D"; // Vercel button URL for markdown export const VERCEL_DEPLOY_BUTTON_URL = `[![Deploy with Vercel](https://vercel.com/button)](${VERCEL_DEPLOY_URL})`; diff --git a/vercel-template.json b/vercel-template.json index 44d9c167e..748a1aedc 100644 --- a/vercel-template.json +++ b/vercel-template.json @@ -8,4 +8,3 @@ } ] } -