Skip to content

πŸ³πŸš€ CookFast is a free AI tool that writes essential product documents (like Requirements Docs & Application Flows) from your idea, helping you start coding faster. Generate docs for Web Apps, Mobile Apps & more!

License

Notifications You must be signed in to change notification settings

webvijayi/CookFast

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ³πŸš€ CookFast: AI-Powered Project Planning Documents πŸ› οΈ

License GitHub stars Twitter Follow

CookFast is an AI-powered tool that automatically generates comprehensive project documentation, templates, and development guides based on your project details. It helps developers quickly convert ideas into structured plans, reducing the initial project setup time significantly.

✨ Features

  • Multiple AI Providers: Choose between Google Gemini, OpenAI, Anthropic, and X.ai models with extensive model selection.
    • OpenAI Models: GPT-5, GPT-5 Mini, GPT-5 Nano, GPT-4.1, o3, o3 Pro, o3 Mini, o3 Deep Research, o4 Mini, o4 Mini High, o4 Mini Deep Research, GPT-4o, GPT-4o Mini
    • Google Gemini Models: Gemini 3 Pro, Gemini 3 Flash, Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5 Flash-Lite, Gemini 2.0 Flash
    • Anthropic Models: Claude Opus 4.5, Claude Opus 4.1, Claude Opus 4, Claude Sonnet 4.5, Claude Sonnet 4, Claude 3.7 Sonnet, Claude 3.5 Sonnet, Claude 3.5 Haiku
    • X.ai Models: Grok 4.1, Grok 4.1 Fast, Grok 4, Grok 4 Fast, Grok 3, Grok 3 Mini
  • Extended Context Windows & Model Selection: Choose from models with varying capabilities:
    • OpenAI GPT-5: 256K tokens context, 32K output tokens - Most intelligent with reasoning and persistent memory
    • OpenAI o3/o3 Pro: 200K tokens context, 65K output tokens - Advanced reasoning models
    • Gemini 3 Flash: 1M tokens context, 64K output tokens - Frontier intelligence with thinking_level control
    • Gemini 3 Pro: 1M tokens context, 64K output tokens - Most capable Gemini with thinking_level
    • Claude Opus 4.5: 200K tokens context, 64K output tokens - 80.9% SWE-bench, effort parameter (low/medium/high)
    • Claude Sonnet 4.5: 200K tokens context, 128K output tokens - Best for coding, agents, computer use
    • X.ai Grok 4.1: 256K tokens context, 32K output tokens - Enhanced agentic tool calling
    • X.ai Grok 4.1 Fast: 2M tokens context, 32K output tokens - Speed-optimized with reasoning toggle
  • Flexible Document Selection: Select the specific planning documents you need, such as:
    • Project Requirements Document
    • Frontend Guidelines
    • Backend Structure Proposal
    • Application Flow Diagram (Mermaid)
    • Tech Stack Documentation
    • System Prompts (if applicable)
    • File Structure Proposal
  • Markdown Output: Generates documents in Markdown format, suitable for easy integration into your project's documentation.
  • Mermaid Diagram Support: Automatically suggests and includes Mermaid syntax for diagrams where appropriate (e.g., App Flow, Backend Structure).
  • API Key Validation: Includes a client-side check to help validate the format and accessibility of your provided API key before generation.
  • Secure API Key Handling: Your API keys are never stored by the application. They are sent directly to the chosen AI provider for the generation request only. The application is open-source for verification.
  • Rate Limiting: Basic API rate limiting is implemented to prevent abuse.
  • Dark Mode: Toggle between light and dark themes for comfortable viewing.
  • Built with Modern Tech: Next.js, React, TypeScript, Tailwind CSS.
  • JSON Export: Download a structured JSON file with project details and document sections for AI IDE integration (e.g., Cursor, Windsurf, Aider).
  • Stop Generation: Cancel an ongoing documentation generation process if needed.
  • Retry Generation: Easily retry the generation process if it fails or if you want to attempt generation again with the same inputs.

πŸ§‘β€πŸ³ Frequently Asked Questions

1. What is CookFast?

CookFast is an AI-powered tool that automatically generates comprehensive project documentation, templates, and development guides based on your project details. It helps developers quickly convert ideas into structured plans, reducing the initial project setup time significantly.

2. What types of projects can CookFast generate documentation for?

CookFast can generate documentation for a wide range of project types including Web Applications, Websites, Mobile Apps, API Services, Libraries/Packages, and Desktop Applications. The tool tailors the documentation based on the specific needs and requirements of each project type.

3. Why was CookFast created?

We built CookFast because we often had project ideas (like CookFast itself) and wanted to get started quickly, but planning would take considerable time. We needed a tool that could help us jumpstart projects with AI-powered documentation and planning, allowing us to focus more on implementation rather than initial documentation.

4. Why is it called 'CookFast'?

The name 'CookFast' comes from the idea that it helps you 'cook up' (prepare) the basics of your idea quickly. Just as a chef prepares ingredients before cooking, CookFast helps prepare your project's foundation fast, so you can start building immediately.

5. Which AI providers does CookFast support?

CookFast supports four major AI providers with extensive model selection:

OpenAI Models:

  • GPT-5/GPT-5 Mini/GPT-5 Nano (256K context, up to 32K output) - Most intelligent with reasoning
  • GPT-4.1 (1M context, 32K output) - Latest flagship with improved coding
  • o3/o3 Pro/o3 Mini (200K context, 65K output) - Advanced reasoning models
  • o3 Deep Research/o4 Mini Deep Research - Multi-step research with citations
  • o4 Mini/o4 Mini High (200K context, 32K output) - Optimized reasoning models
  • GPT-4o/GPT-4o Mini (128K context, 16K output) - Multimodal capabilities

Google Gemini Models:

  • Gemini 3 Pro/Gemini 3 Flash (1M context, 64K output) - Frontier with thinking_level parameter
  • Gemini 2.5 Pro (1M+ context, 65K output) - Always-on thinking
  • Gemini 2.5 Flash (1M+ context, 65K output) - Configurable thinking budget
  • Gemini 2.0 Flash (1M context, 32K output) - Next-gen with native tool use

Anthropic Models:

  • Claude Opus 4.5 (200K context, 64K output) - 80.9% SWE-bench, effort parameter
  • Claude Opus 4.1 (200K context, 128K output) - Enhanced for agentic tasks
  • Claude Opus 4 (200K context, 128K output) - Most capable with hybrid reasoning
  • Claude Sonnet 4.5 (200K context, 128K output) - Best for coding and agents
  • Claude Sonnet 4 (200K context, 128K output) - High performance hybrid reasoning
  • Claude 3.7 Sonnet (200K context, 64K output) - Extended reasoning enabled

X.ai Models:

  • Grok 4.1 (256K context, 32K output) - Enhanced agentic tool calling
  • Grok 4.1 Fast (2M context, 32K output) - Speed-optimized with reasoning toggle
  • Grok 4/Grok 4 Fast (256K-2M context, 32K output) - Frontier-level reasoning
  • Grok 3/Grok 3 Mini (128K-1M context, up to 16K output) - Cost-efficient reasoning

6. Do I need to provide my own API keys?

Yes, you'll need to provide your own API key for the AI provider you choose to use. This ensures your data security and gives you control over which AI model processes your project information.

7. What types of documentation can CookFast generate?

CookFast can generate requirements documents, frontend guidelines, backend architecture, application flow, tech stack documentation, system prompts, and file structure documentation.

8. Can I customize the documentation CookFast generates?

Yes! You can customize the documentation by adjusting your project details and selecting specific document types. After generation, you can also download the documentation as Markdown or JSON and then modify it to suit your specific needs. We're also working on more customization options in future updates.

9. Is my API key saved?

No. API keys are validated client-side and never stored by CookFast. They are sent directly to the chosen AI provider for the generation request only.

Getting Started

Prerequisites

Installation & Running Locally

  1. Clone the repository:

    git clone https://github.com/webvijayi/CookFast.git
    cd CookFast
  2. Install dependencies:

    npm install
    # or
    yarn install
    # or
    pnpm install
  3. Run the development server:

    npm run dev
  4. Open http://localhost:3000 with your browser to see the application.

🌐 Live Demo

https://cookfa.st

How to Use

  1. Select your preferred AI Provider (Google Gemini, OpenAI, Anthropic, or X.ai).
  2. Choose your specific model from the available options for enhanced control.
  3. Enter your corresponding API Key and optionally click "Test" to validate it.
  4. Fill in the details about your project (Name, Type, Goal, Features, Tech Stack).
  5. Select the checkboxes for the document types you want to generate.
  6. Click "Cook Up Docs!".
  7. While generating, a "Stop Generation" button is available if you need to cancel.
  8. The generated Markdown content will appear in the results area below the form.
  9. If the generation fails or you want to try again, a "Retry Generation" button will be available in the results area.

❀️ Support & Contribution

Found CookFast helpful? Here are a few ways you can support the project:

  • ⭐ Star the Repository: If you like the project, please star it on GitHub! It helps with visibility.
  • β˜• Donate: Support the development by buying me a coffee!
    Buy Me A Coffee
  • 🐞 Report Bugs / Suggest Features: Found a bug or have an idea? Open an issue on the GitHub Issues page.
  • 🀝 Contribute Code: Pull requests are welcome! Feel free to fork the repository and submit your improvements.
  • πŸ“§ Contact: For other inquiries, you can reach out to care [at] webvijayi [dot] com.

πŸš€ Deployment

This application is configured for deployment on platforms like Netlify, Vercel, or self-hosted solutions like Coolify.

Docker Deployment

CookFast includes a Dockerfile for easy containerized deployment:

# Build the Docker image
docker build -t cookfast .

# Run the container
docker run -p 3000:3000 cookfast

Or use Docker Compose:

version: '3.8'
services:
  cookfast:
    build: .
    ports:
      - "3000:3000"
    restart: unless-stopped

Coolify Deployment

CookFast is optimized for deployment on Coolify:

  1. Create a new application in Coolify
  2. Connect to the GitHub repository: webvijayi/CookFast
  3. Coolify will automatically detect the Dockerfile
  4. Configure your domain and SSL
  5. Deploy!

Netlify/Vercel Deployment

The code is designed to be easily deployable on platforms like Vercel or Netlify with zero configuration.

Netlify Blobs Integration

CookFast uses Netlify Blobs for storing generated documents in production environments:

  • Zero Configuration: Netlify Blobs is automatically configured when deployed on Netlify
  • Persistent Storage: Documents are stored persistently even through redeployments
  • Local Development: In local development, files are stored in the tmp directory as a fallback
  • High Availability: Netlify Blobs provides a highly-available, scalable storage solution

To work with Netlify Blobs locally, you can use the following commands:

# Start Netlify dev environment
npm run netlify:dev

# List all blobs in the store
npm run netlify:blobs:list

# Delete a specific blob
npm run netlify:blobs:delete generationResults/YOUR_REQUEST_ID

For more information about Netlify Blobs, see the documentation.


Learn More (Default Next.js Info)

To learn more about the underlying Next.js framework, take a look at the following resources:

About

πŸ³πŸš€ CookFast is a free AI tool that writes essential product documents (like Requirements Docs & Application Flows) from your idea, helping you start coding faster. Generate docs for Web Apps, Mobile Apps & more!

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages