Skip to main content
Public
README.md 2.93 KB

🚀 DevFlow

DevFlow is a lightweight, open-source developer companion designed to automate the repetitive parts of your workflow. Built for speed and simplicity, it brings AI-powered architecture mapping, instant code formatting, and API testing into a single, clean interface.

!Version !License !Status


✨ Key Features

  • 🏗️ AI Architect: Generate complete project file structures and initialization commands by simply describing your idea.
  • 📄 Readme Helper: Instantly transform project briefs into professional, GitHub-ready README.md files using Google Gemini.
  • 🌐 API Playground: A built-in, lightweight REST client to test endpoints and inspect responses without leaving the app.
  • ✨ Code Formatter: Validate and prettify messy JSON payloads with one click.
  • 🪵 Log Factory: Stop typing manual debug logs. Generate consistent log statements for JavaScript, Python, and Java.

  • 🛠️ Tech Stack

  • Framework: React 19
  • Styling: Tailwind CSS
  • Icons: Lucide React
  • AI Engine: Google Gemini API (@google/genai)
  • Type Safety: TypeScript

  • 🚀 Getting Started

    Prerequisites

  • A modern web browser.
  • A Google Gemini API Key (DevFlow uses process.env.API_KEY to interact with the models).
  • Running Locally

    1. Clone the repository:

    BASH
    1
    2
       git clone https://appsgm.com/code/devflow.git
    

    cd devflow

    2. DevFlow is built as a single-page module application. Simply host the root directory using any local development server (like npx serve, Live Server for VS Code, or Vite).

    3. Ensure your API_KEY is available in your environment for the AI features to work.


    📖 Usage Examples

    1. Planning a New Project

    Navigate to AI Architect, enter "A weather app using OpenWeather API and React", and hit Construct. You'll get a full folder structure and the npm install commands needed to start.

    2. Debugging an API

    Open API Playground, paste your endpoint URL, and click Send. You can see the status code, response time, and the raw JSON body instantly.


    🤝 Contributing

    Contributions are welcome! Whether it's adding a new log template or improving the UI, feel free to fork the repo and submit a PR.

    1. Fork the Project 2. Create your Feature Branch (git checkout -b feature/AmazingFeature) 3. Commit your Changes (git commit -m 'Add some AmazingFeature') 4. Push to the Branch (git push origin feature/AmazingFeature) 5. Open a Pull Request


    📄 License

    Distributed under the MIT License. See LICENSE for more information.

    Built with ☕ and ❤️ by the DevFlow community.

    About

    A lightweight AI-powered developer companion that automates repetitive workflows with architecture mapping, code formatting, API testing, and README generation—all in one clean interface.


    19 files
    2 folders
    38.72 KB total size
    0 open issues
    0 open pull requests
    0 watchers
    0 forks
    0 stars
    47 views
    Updated 5 days ago
    Languages
    TypeScript 96.8%
    HTML 3.2%