🛠️ Readme Forge

AI-powered tool that generates professional README.md files through natural language input

Table of Contents

• Overview
• Features
• Quick Start
  • Prerequisites
  • Installation
  • Configuration
  • Development
• Architecture
• Technology Stack
  • Backend
  • Frontend
  • Development Tools
• Production
• Contributing
• License

Overview

Readme Forge empowers developers—regardless of technical writing skill—to quickly turn project details into clear, consistent, and professional README files. By leveraging conversational AI, it organizes raw input into well-structured documentation, ensuring every software project in your organization maintains high-quality, standardized readmes.

Features

• Natural Language Input - Describe your project in plain English
• AI-Generated Documentation - High-quality markdown output powered by LangChain.js
• Modern Stack - React frontend with Hono API backend
• Monorepo Structure - Organized workspace using Turborepo

Quick Start

Prerequisites

• Node.js 18+
• npm
• OpenAI API key

Installation

git clone https://github.com/yourname/readme-forge.git
cd readme-forge
npm install

Configuration

Create .env in apps/api/:

OPENAI_API_KEY=your-api-key-here

Create .env in apps/web/:

VITE_API_BASE_URL=http://localhost:8787 //replace for production deployment
VITE_API_TIMEOUT=30000

Development

npm run dev

Services:

• Frontend: http://localhost:5173
• API: http://localhost:8787

Architecture

readme-forge/
├── apps/
│   ├── api/          # Hono API with LangChain.js
│   └── web/          # React frontend
├── turbo.json        # Turborepo configuration
└── package.json      # Workspace scripts

Technology

Backend

• Hono - Fast web framework
• LangChain.js - AI orchestration and OpenAI integration
• Zod - Runtime type validation
• dotenv - Environment variable management

Frontend

• React + Vite - Modern development experience
• TypeScript - Type safety
• Tailwind CSS - Utility-first styling
• React Hook Form - Form state management
• Radix UI - Accessible component primitives
• Lucide React - Consistent iconography

Development Tools

• Turborepo - Monorepo build orchestration
• ESLint - Code quality and consistency

Production

Build for production:

npm run build

This creates optimized builds for both frontend and backend applications.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

MIT License

Built with ❤️ using modern web technologies