ReadCraft

ReadCraft is an AI-powered platform that helps developers generate professional GitHub README files and project documentation in seconds. It analyzes repository information and produces clean, well-structured Markdown documentation ready for production use.

---

Features

• AI-powered README generation
• GitHub repository integration
• Live Markdown editor
• Real-time Markdown preview
• Copy README to clipboard
• Download README.md
• README history management
• Repository management
• User settings
• Responsive design
• Dark mode support

---

Tech Stack

Frontend

• Next.js (App Router)
• React
• TypeScript
• Tailwind CSS
• shadcn/ui
• Framer Motion

Backend

• Next.js Route Handlers

AI

• Gemini API (Planned)
• OpenAI API (Planned)

Database (Planned)

• PostgreSQL
• Prisma ORM

Authentication (Planned)

• Better Auth

---

Project Structure

src/
├── app/
├── components/
├── features/
├── hooks/
├── lib/
├── services/
├── types/
└── utils/

docs/
├── AI_CONTEXT.md
└── designs/

---

Getting Started

Clone the repository

git clone https://github.com/NourMoftah/ReadCraft.git

Install dependencies

npm install

Start the development server

npm run dev

Open your browser and visit:

http://localhost:3000

---

Roadmap

• Landing Page
• Dashboard
• README Generator
• GitHub Integration
• AI Integration
• Authentication
• Database Integration
• Subscription System
• Team Collaboration

---

Vision

ReadCraft is designed to become a complete AI-powered documentation platform for developers. The long-term goal is to provide intelligent tools for generating README files, project documentation, changelogs, contribution guides, and other developer resources from a single platform.

---

License

This project is licensed under the MIT License.