- ✨ Features
- 🎨 Design Philosophy
- 🛠️ Tech Stack
- 🚀 Quick Start
- 📁 Project Structure
- 🎯 Core Features
- 🌐 API Reference
- 🎨 UI Components
- 📱 Pages & Navigation
- 🔧 Configuration
- 🚀 Deployment
- 🧪 Testing
- 📊 Performance
- 🤝 Contributing
- 🐛 Troubleshooting
- 📈 Roadmap
- 📄 License
- 🙏 Acknowledgments
- 📊 Stats
- AI-Powered Generation: Automatically create portfolios from GitHub profiles
- Real-time GitHub Integration: Live repository data and README parsing
- Multiple Templates: Choose from professionally designed templates
- Responsive Design: Perfect on desktop, tablet, and mobile
- SEO Optimized: Built-in meta tags and structured data
- Performance First: 95+ Lighthouse scores across all metrics
- Glassmorphic Design: Beautiful frosted glass effects with backdrop blur
- Smooth Animations: Micro-interactions and hover effects
- Dark/Light Mode: Automatic theme switching
- Mobile-First: Responsive design with collapsible navigation
- Accessibility: WCAG 2.1 AA compliant
- Portfolio Management: Create, edit, and delete portfolios
- Performance Tracking: View counts, engagement metrics
- Template Library: Browse and preview available templates
- Real Examples: Showcase of successful portfolios
DevForge embraces a modern glassmorphic design that combines elegance with functionality:
/* Core glassmorphic styling */
.glassmorphic-nav {
background: rgba(255, 255, 255, 0.1);
backdrop-filter: blur(16px);
border: 1px solid rgba(255, 255, 255, 0.2);
border-radius: 16px;
box-shadow: 0 8px 32px rgba(0, 0, 0, 0.1);
}- Transparency: Layered glass effects create depth
- Blur Effects: Backdrop filters for modern aesthetics
- Gradient Accents: Purple-to-blue gradients for CTAs
- Rounded Corners: Consistent 16px+ border radius
- Hover States: Scale and glow effects on interaction
- Next.js 15 - React framework with App Router
- TypeScript - Type-safe JavaScript
- Tailwind CSS - Utility-first CSS framework
- shadcn/ui - High-quality React components
- Lucide React - Beautiful icon library
- next-themes - Theme management
- Next.js API Routes - Serverless API endpoints
- GitHub API v3 - Repository and user data
- Vercel Functions - Serverless deployment
- ESLint - Code linting
- Prettier - Code formatting
- PostCSS - CSS processing
- Autoprefixer - CSS vendor prefixes
- Node.js 18+
- npm or yarn
- Git
-
Clone the repository
git clone https://github.com/your-username/devforge.git cd devforge -
Install dependencies
npm install # or yarn install -
Set up environment variables
cp .env.example .env.local
Add your environment variables:
NEXT_PUBLIC_BASE_URL=http://localhost:3000 GITHUB_TOKEN=your_github_personal_access_token
-
Run the development server
npm run dev # or yarn dev -
Open your browser Navigate to http://localhost:3000
# Generate a portfolio for a GitHub user
curl http://localhost:3000/api/github/octocatdevforge/
├── app/ # Next.js App Router
│ ├── api/ # API routes
│ │ └── github/ # GitHub integration
│ │ └── [username]/route.ts # User data endpoint
│ ├── components/ # Page components
│ │ ├── navigation.tsx # Glassmorphic navbar
│ │ ├── hero-section.tsx # Landing hero
│ │ ├── features-section.tsx # Feature showcase
│ │ └── ... # Other sections
│ ├── dashboard/ # Dashboard pages
│ │ └── page.tsx # Portfolio management
│ ├── generator/ # AI generator
│ │ ├── page.tsx # Generator interface
│ │ └── components/ # Generator components
│ ├── portfolio/ # Dynamic portfolios
│ │ └── [username]/ # User portfolio pages
│ ├── templates/ # Template gallery
│ ├── examples/ # Portfolio examples
│ ├── docs/ # Documentation
│ ├── layout.tsx # Root layout
│ ├── page.tsx # Homepage
│ └── globals.css # Global styles
├── components/ # Reusable components
│ ├── ui/ # shadcn/ui components
│ └── theme-provider.tsx # Theme context
├── lib/ # Utilities
│ └── utils.ts # Helper functions
├── public/ # Static assets
│ ├── placeholder.svg # Placeholder images
│ └── ... # Other assets
├── next.config.mjs # Next.js configuration
├── tailwind.config.ts # Tailwind configuration
├── tsconfig.json # TypeScript configuration
└── package.json # Dependencies