Get FlowKit running locally in under 5 minutes!

• Node.js 18.x or higher (Download)
• MySQL 8.x or compatible database provider
• npm or yarn package manager

1. Clone the repository

   git clone https://github.com/harshit-exe/FlowKit.git
   cd FlowKit

2. Install dependencies

   npm install

3. Set up environment variables

   cp .env.example .env

   Edit .env and configure your database and API keys (see Environment Variables below)

4. Set up the database

   # Generate Prisma client
   npx prisma generate
   
   # Push schema to database
   npx prisma db push
   
   # Seed with sample data (super admin + workflows)
   npx prisma db seed

5. Start the development server

   npm run dev

6. Open your browser 🎉

   • Public site: http://localhost:3000
   • Admin panel: http://localhost:3000/admin

   Default Admin Credentials:

   • Email: [email protected]
   • Password: Admin@123!

   ⚠️ Change these credentials immediately after first login!

Create a .env file in the root directory with the following variables:

💡 Tip: Check .env.example for detailed descriptions and instructions for each variable.

FlowKit supports any MySQL-compatible database. Here are some recommended providers:

# Install MySQL locally
brew install mysql  # macOS
# or download from https://dev.mysql.com/downloads/

# Create database
mysql -u root -p
CREATE DATABASE flowkit;

• Aiven - Free tier available, excellent performance
• PlanetScale - Serverless MySQL, generous free tier
• Railway - Easy setup, good for development

If your database requires SSL, append to your DATABASE_URL:

?sslaccept=strict

# Generate Prisma Client (after schema changes)
npx prisma generate

# Push schema changes to database (development)
npx prisma db push

# Run migrations (production)
npx prisma migrate deploy

# Seed database with sample data
npx prisma db seed

# Open Prisma Studio (visual database editor)
npx prisma studio

flowkit/
├── prisma/
│   ├── schema.prisma          # Database schema
│   └── seed.ts                # Database seeding script
├── src/
│   ├── app/
│   │   ├── (public)/          # Public-facing pages
│   │   │   ├── page.tsx       # Homepage
│   │   │   ├── workflows/     # Workflow listings & details
│   │   │   └── ai-builder/    # AI workflow generator
│   │   ├── admin/             # Admin panel
│   │   │   ├── dashboard/     # Admin dashboard
│   │   │   ├── workflows/     # Workflow management
│   │   │   └── categories/    # Category management
│   │   └── api/               # API routes
│   │       ├── workflows/     # Workflow CRUD APIs
│   │       ├── search/        # Search API
│   │       └── ai/            # AI generation API
│   ├── components/
│   │   ├── admin/             # Admin-specific components
│   │   ├── layout/            # Layout components (navbar, footer)
│   │   ├── workflow/          # Workflow display components
│   │   └── ui/                # shadcn/ui components
│   ├── lib/
│   │   ├── prisma.ts          # Prisma client instance
│   │   ├── auth.ts            # NextAuth configuration
│   │   ├── gemini.ts          # Google Gemini AI client
│   │   └── utils.ts           # Utility functions
│   └── types/                 # TypeScript type definitions
├── public/
│   ├── thumbnails/            # Workflow thumbnail images
│   └── assets/                # Static assets
└── package.json

FlowKit provides a RESTful API for managing workflows:

• GET /api/workflows - List all workflows (with pagination & filters)
• POST /api/workflows - Create a new workflow
• GET /api/workflows/[id] - Get workflow by ID
• PUT /api/workflows/[id] - Update workflow
• DELETE /api/workflows/[id] - Delete workflow
• GET /api/workflows/[id]/stats - Get workflow statistics

• GET /api/search - Search workflows by keywords, tags, categories
• GET /api/categories - List all categories
• GET /api/tags - List all tags

• POST /api/ai/generate - Generate workflow using AI (Gemini)

• POST /api/workflows/[id]/vote - Upvote/downvote workflow
• POST /api/workflows/[id]/save - Save workflow to collection
• GET /api/workflows/[id]/comments - Get workflow comments

📖 For detailed API documentation, visit our API Reference.

1. Push to GitHub

   git push origin main

2. Import to Vercel

   • Go to vercel.com
   • Click "New Project"
   • Import your GitHub repository
   • Vercel will auto-detect Next.js

3. Configure Environment Variables

   • Add all variables from your .env file
   • Update NEXTAUTH_URL to your production domain

4. Deploy

   • Click "Deploy"
   • Your app will be live in ~2 minutes!

Before deploying to production:

• Change default admin password
• Use strong NEXTAUTH_SECRET (generate new one)
• Configure production database with SSL
• Set up proper email service (Resend recommended)
• Enable Cloudinary for image uploads
• Configure domain for NEXTAUTH_URL
• Set up analytics (optional but recommended)
• Review and update robots.txt and sitemap.xml
• Test all workflows and admin features
• Set up database backups

# Coming soon - Dockerfile in progress

# Build the application
npm run build

# Start with PM2
pm2 start npm --name "flowkit" -- start

• Framework: Next.js 14 (App Router)
• Language: TypeScript
• Database: MySQL with Prisma ORM
• Authentication: NextAuth.js
• Styling: Tailwind CSS
• UI Components: shadcn/ui
• AI: Google Gemini 2.0 Flash
• Email: Resend / Nodemailer
• Image Upload: Cloudinary
• Analytics: Vercel Analytics, Microsoft Clarity

We love contributions! FlowKit is better because of developers like you. 🙌

• 🐛 Report bugs - Found an issue? Open a bug report
• ✨ Suggest features - Have ideas? Request a feature
• 📝 Improve documentation - Help others understand FlowKit better
• 🔧 Submit PRs - Fix bugs or add features
• 📦 Share workflows - Contribute your n8n workflows

1. Fork the repository
2. Create your feature branch: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m 'feat: add amazing feature'
4. Push to the branch: git push origin feature/amazing-feature
5. Open a Pull Request

📖 Read our Contributing Guide for detailed guidelines and coding standards.

💡 Still stuck? Open an issue and we'll help!

Coming soon! Check out the live demo in the meantime.

This project is licensed under the MIT License - see the LICENSE file for details.

FlowKit wouldn't be possible without these amazing projects:

• n8n - The powerful workflow automation tool that inspired this project
• shadcn/ui - Beautiful and accessible UI components
• Google Gemini - AI-powered workflow generation
• Vercel - Hosting and deployment platform
• All our contributors ❤️

• 🌐 Website: flowkit.in
• 💬 Discussions: GitHub Discussions
• 🐛 Issues: GitHub Issues
• 👤 Author: @harshit-exe