Skip to content

Updated README.md, cleaned up slop. #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
madfozjer wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Updated README.md, cleaned up slop. #204

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
57bc63b
Update README.md with new deployment and repository links. Deleted so…
madfozjer Jul 27, 2025
555db3f
Refactor: Clean up README.md
madfozjer Jul 27, 2025
599ff8b
Update the README.md file to remove a redundant Netlify badge and fix…
madfozjer Jul 27, 2025
343f03b
Merge pull request #1 from madfozjer/master
madfozjer Jul 27, 2025
14c3a7e
Update the README.md file to improve the formatting of the contributo…
madfozjer Jul 27, 2025
d32d15b
Merge pull request #2 from madfozjer/master
madfozjer Jul 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 9 additions & 165 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,9 @@
[![Framer Motion](https://img.shields.io/badge/Framer_Motion-Animations-0055FF?style=for-the-badge&logo=framer&logoColor=white)](https://www.framer.com/motion/)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
[![Open Source](https://img.shields.io/badge/Open%20Source-❤️-red?style=for-the-badge)](https://github.com/docmagic-ai/docmagic)
[![Netlify Status](https://img.shields.io/badge/Netlify-Deployed-00C7B7?style=for-the-badge&logo=netlify&logoColor=white)](https://docmagic1.netlify.app)
[![Version](https://img.shields.io/badge/Version-0.8.0-brightgreen?style=for-the-badge)](https://github.com/docmagic-ai/docmagic/releases)
[![Version](https://img.shields.io/badge/Version-0.8.0-brightgreen?style=for-the-badge)](https://github.com/Muneerali199/DocMagic/releases)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge)](http://makeapullrequest.com)
[![Contributors](https://img.shields.io/badge/Contributors-Welcome-orange?style=for-the-badge)](./CONTRIBUTING.md)

[![Contributors](https://img.shields.io/badge/Contributors-Welcome-orange?style=for-the-badge)]()
<br />

![DocMagic Hero](screenshots/DocMagicHero.png)
Expand All @@ -35,11 +32,9 @@

<br />

[![Live Demo](https://img.shields.io/badge/🌐_Live_Demo-Visit_DocMagic-667eea?style=for-the-badge&logoColor=white)](https://docmagic1.netlify.app)
[![About Page](https://img.shields.io/badge/📖_About_Page-Learn_More-9333EA?style=for-the-badge&logoColor=white)](https://docmagic1.netlify.app/about)
[![Fork on GitHub](https://img.shields.io/badge/🍴_Fork-on_GitHub-black?style=for-the-badge&logo=github&logoColor=white)](https://github.com/docmagic-ai/docmagic/fork)
[![Documentation](https://img.shields.io/badge/📚_Documentation-Read_Docs-4ECDC4?style=for-the-badge&logoColor=white)](./CONTRIBUTING.md)
[![API Reference](https://img.shields.io/badge/🔗_API_Reference-Explore_API-FF6B6B?style=for-the-badge&logoColor=white)](./API.md)
[![Live Demo](https://img.shields.io/badge/🌐_Live_Demo-Visit_DocMagic-667eea?style=for-the-badge&logoColor=white)](https://doc-magic-heob.vercel.app/)
[![About Page](https://img.shields.io/badge/📖_About_Page-Learn_More-9333EA?style=for-the-badge&logoColor=white)](https://doc-magic-heob.vercel.app/about)
[![Fork on GitHub](https://img.shields.io/badge/🍴_Fork-on_GitHub-black?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Muneerali199/DocMagic/fork)

</div>

Expand Down Expand Up @@ -71,14 +66,10 @@

### 🎨 **Modern UI/UX Design**

- **✨ Glass Morphism Interface**: Modern glass-effect components with subtle transparency and blur effects
- **🌈 Gradient Magic**: Dynamic bolt gradients and shimmer effects throughout the interface
- **🎭 Floating Animations**: Smooth floating orbs and animated background elements powered by Framer Motion
- **📱 Responsive Excellence**: Mobile-first design optimized for all screen sizes
- **🌙 Dark/Light Theme**: Seamless theme switching with next-themes
- **♿ Accessibility First**: WCAG 2.1 AA compliant components
- **🎯 Magical Professionalism**: Design philosophy combining cutting-edge visual effects with professional usability
- **Micro-Interactions**: Hover effects, scale transitions, and pulse animations for enhanced user engagement

### 🤖 **AI-Powered Document Generation**

Expand Down Expand Up @@ -210,70 +201,6 @@ DocMagic features a cutting-edge design system built around glass morphism princ
- Debounced search and form inputs
- Optimistic UI updates for instant feedback

## 📸 Platform Screenshots

<div align="center">

### 🏠 **Landing Page with Glass Morphism Design**

<img src="https://images.pexels.com/photos/3184291/pexels-photo-3184291.jpeg?auto=compress&cs=tinysrgb&w=1200&h=600" alt="DocMagic Landing Page" width="90%"/>
<p><em>Hero section with floating animations and gradient effects</em></p>

### 📄 **AI Resume Generator Interface**

<img src="https://images.pexels.com/photos/3184292/pexels-photo-3184292.jpeg?auto=compress&cs=tinysrgb&w=1200&h=600" alt="Resume Generator" width="90%"/>
<p><em>Intelligent resume builder with real-time ATS optimization</em></p>

### 🎯 **Presentation Studio with Smart Layouts**

<img src="https://images.pexels.com/photos/3184293/pexels-photo-3184293.jpeg?auto=compress&cs=tinysrgb&w=1200&h=600" alt="Presentation Creator" width="90%"/>
<p><em>Professional slide creator with automatic chart generation</em></p>

## 🏗️ **Technical Architecture**

### 🚀 **Frontend Stack**

```typescript
// Core Framework
Next.js 15.4.0 // React framework with App Router
React 18.3.1 // UI library with concurrent features
TypeScript 5.8.3 // Type-safe development

// Styling & UI
Tailwind CSS 3.4.17 // Utility-first CSS framework
Radix UI // Accessible component primitives
Framer Motion 12.23.6 // Animation library
next-themes 0.4.6 // Theme management

// Forms & Validation
React Hook Form 7.60.0 // Performant forms
Zod 3.25.76 // Schema validation
```

### 🔧 **Backend & Services**

```typescript
// Database & Auth
Supabase // PostgreSQL database + Auth
@supabase/auth-helpers-nextjs 0.10.0
@supabase/supabase-js 2.52.0

// AI & Generation
Google Gemini AI // Document generation
@google/generative-ai 0.3.1 // Official Gemini SDK

// Payments
Stripe 14.25.0 // Payment processing
@stripe/stripe-js 3.5.0 // Client-side Stripe

// Document Processing
mammoth 1.9.1 // DOCX parsing
pdf-parse 1.1.1 // PDF parsing
docx 8.5.0 // DOCX generation
jspdf 2.5.2 // PDF generation
pptxgenjs 3.12.0 // PowerPoint generation
```

### 📊 **Document Processing Pipeline**

```mermaid
Expand All @@ -286,83 +213,11 @@ graph LR
F --> G[PDF/DOCX/PPTX]
```

### 🔍 **ATS Analyzer System**

<img src="https://images.pexels.com/photos/3184294/pexels-photo-3184294.jpeg?auto=compress&cs=tinysrgb&w=1200&h=600" alt="ATS Analyzer" width="90%"/>
<p><em>Real-time resume analysis with actionable insights</em></p>

</div>

## 📁 Project Structure

```
docmagic/
├── app/ # Next.js app directory
│ ├── api/ # API routes
│ │ ├── analyze/ # Resume analysis endpoints
│ │ ├── auth/ # Authentication endpoints
│ │ ├── generate/ # Document generation endpoints
│ │ ├── send-email/ # Email sending functionality
│ │ ├── stripe/ # Stripe payment integration
│ │ └── user/ # User data endpoints
│ ├── auth/ # Authentication pages
│ ├── cv/ # CV generator page
│ ├── letter/ # Letter generator page
│ ├── presentation/ # Presentation generator page
│ ├── resume/ # Resume generator pages
│ ├── settings/ # User settings page
│ ├── globals.css # Global styles
│ ├── layout.tsx # Root layout component
│ └── page.tsx # Home page
├── components/ # React components
│ ├── auth-provider.tsx # Authentication context provider
│ ├── document-card.tsx # Document type card component
│ ├── features-section.tsx # Features showcase section
│ ├── hero-section.tsx # Landing page hero section
│ ├── letter/ # Letter-specific components
│ ├── presentation/ # Presentation-specific components
│ ├── resume/ # Resume-specific components
│ ├── site-header.tsx # Navigation header
│ ├── sponsor-banner.tsx # Sponsor information banner
│ ├── subscription-button.tsx # Subscription management
│ ├── testimonials-section.tsx # User testimonials
│ ├── theme-provider.tsx # Dark/light theme provider
│ ├── theme-toggle.tsx # Theme toggle button
│ └── ui/ # UI components (shadcn/ui)
├── hooks/ # Custom React hooks
│ ├── use-subscription.ts # Subscription state management
│ └── use-toast.ts # Toast notifications
├── lib/ # Utility libraries
│ ├── gemini.ts # Google Gemini AI integration
│ ├── parsers/ # Document parsing utilities
│ ├── stripe.ts # Stripe payment configuration
│ ├── supabase/ # Supabase client configuration
│ └── utils.ts # General utility functions
├── public/ # Static assets
├── supabase/ # Supabase configuration
│ └── migrations/ # Database migration files
├── types/ # TypeScript type definitions
│ └── supabase.ts # Supabase database types
├── .env.local # Environment variables (not in repo)
├── .eslintrc.json # ESLint configuration
├── .gitignore # Git ignore file
├── CONTRIBUTING.md # Contribution guidelines
├── LICENSE # MIT license
├── README.md # Project documentation
├── middleware.ts # Next.js middleware
├── netlify.toml # Netlify deployment configuration
├── next.config.js # Next.js configuration
├── package.json # Project dependencies
├── postcss.config.js # PostCSS configuration
├── tailwind.config.ts # Tailwind CSS configuration
└── tsconfig.json # TypeScript configuration
```

## 🚀 **Quick Start Guide**

### 🌐 **Learn More**

Visit our comprehensive **About Page** at [https://docmagic1.netlify.app/about](https://docmagic1.netlify.app/about) to explore:
Visit our comprehensive **About Page** at [https://docmagic1.netlify.app/about](https://doc-magic-heob.vercel.app/about) to explore:

- 🎯 **Mission & Vision** - Our commitment to democratizing document creation
- ⚡ **Core Features** - AI-powered tools and capabilities
Expand Down Expand Up @@ -804,7 +659,7 @@ The application is deployed on Netlify. To deploy your own instance:
#### 🐛 **Bug Reports & Fixes**

- Report bugs using our [issue template](https://github.com/docmagic-ai/docmagic/issues/new?template=bug_report.md)
- Fix existing bugs and earn contributor recognition
- Fix existing bugs
- Help improve stability and user experience

#### ✨ **Feature Development**
Expand Down Expand Up @@ -846,8 +701,6 @@ We celebrate our contributors! Every contribution gets:
- 🎁 **Exclusive swag** for significant contributions
- 💼 **Portfolio showcase** opportunities

For detailed guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md).

## 📜 **Open Source License**

**DocMagic is free and open source software** licensed under the MIT License. This means you can:
Expand Down Expand Up @@ -998,8 +851,6 @@ Got questions? Check out our comprehensive [FAQ](./FAQ.md) for answers to common

### 🆘 **Get Help**

- 📚 **Documentation**: [docs.docmagic.com](https://docs.docmagic.com)
- 💬 **Discord Community**: [Join our Discord](https://discord.gg/docmagic)
- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/yourusername/docmagic/issues)
- 💡 **Feature Requests**: [GitHub Discussions](https://github.com/yourusername/docmagic/discussions)

Expand All @@ -1012,19 +863,16 @@ Got questions? Check out our comprehensive [FAQ](./FAQ.md) for answers to common

### 🌐 **Social Media**

- **Twitter**: [@DocMagicAI](https://twitter.com/DocMagicAI)
- **LinkedIn**: [DocMagic Company](https://linkedin.com/company/docmagic)
- **GitHub**: [DocMagic Organization](https://github.com/docmagic-ai)

---

<div align="center">

### 🚀 **Ready to Create Magic?**

[![Get Started](https://img.shields.io/badge/🚀_Get_Started-Create_Your_First_Document-667eea?style=for-the-badge&logoColor=white)](https://docmagic1.netlify.app)
[![Get Started](https://img.shields.io/badge/🚀_Get_Started-Create_Your_First_Document-667eea?style=for-the-badge&logoColor=white)](https://doc-magic-heob.vercel.app/)
[![Star on GitHub](https://img.shields.io/badge/⭐_Star_on_GitHub-Support_the_Project-yellow?style=for-the-badge&logoColor=white)](https://github.com/yourusername/docmagic)
[![Join Discord](https://img.shields.io/badge/💬_Join_Discord-Community_Chat-5865F2?style=for-the-badge&logoColor=white)](https://discord.gg/docmagic)

<br />

Expand All @@ -1034,8 +882,6 @@ _Transforming ideas into professional documents, one AI generation at a time._

<br />

![Footer Image](https://via.placeholder.com/600x100/667eea/ffffff?text=✨+DocMagic+-+AI+Document+Creation+Platform+✨)

</div>

| Endpoint | Method | Description | Request Body | Response |
Expand Down Expand Up @@ -1298,16 +1144,14 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
---

<div align="center">
## 🌟 Top Contributors
🌟 Top Contributors

We sincerely thank the amazing individuals who have contributed to DocMagic. Your time, effort, and ideas make this project better every day.

<!-- You can use GitHub's built-in contributors image -->

[![Contributors](https://contrib.rocks/image?repo=Muneerali199/DocMagic)](https://github.com/Muneerali199/DocMagic/graphs/contributors)

> Want to contribute? Check out our [CONTRIBUTING.md](CONTRIBUTING.md) guide and submit your first PR!

<p>Built with ❤️ by the DocMagic Team</p>
<p><strong>Designed by <a href="https://github.com/Xenonesis">Xenonesis</a></strong></p>
<p>© 2025 DocMagic. All rights reserved.</p>
Expand Down