Devfolio Documentation

This is a modern documentation site built with Fumadocs and Next.js, featuring analytics, user feedback, and more.

Features

• 📊 Analytics Integration - Tracks page views, time on page, and user interactions
• 👍 Helpful Rating System - Users can rate documentation pages
• 🤖 Chatbot Integration - AI-powered assistance (coming soon)
• 📱 Mobile Responsive - Works on all devices
• 🚀 CI/CD Pipeline - Automated testing and deployment

Getting Started

Prerequisites

• Node.js 18+ and npm/yarn/pnpm
• A PostHog account for analytics

Installation

1. Clone the repository

   git clone https://github.com/your-username/devfolio-docs.git
   cd devfolio-docs

2. Install dependencies

   npm install
   # or
   yarn install
   # or
   pnpm install

3. Set up environment variables

   cp .env.local.example .env.local

   Update .env.local with your PostHog credentials:

   NEXT_PUBLIC_POSTHOG_KEY=your_posthog_project_key
   NEXT_PUBLIC_POSTHOG_HOST=https://app.posthog.com  # or your self-hosted instance

4. Run the development server

   npm run dev
   # or
   yarn dev
   # or
   pnpm dev

   Open http://localhost:3000 with your browser to see the result.

Development

Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm start - Start production server
• npm test - Run tests
• npm run lint - Run ESLint
• npm run type-check - Check TypeScript types

Deployment

Vercel

Manual Deployment

1. Build the application:

   npm run build

2. Start the production server:

   npm start

Analytics

This project uses PostHog for analytics. The following events are tracked:

• Page views
• Time spent on page
• Document helpfulness ratings
• Search queries (coming soon)
• Chatbot interactions (coming soon)

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

• Fumadocs - Documentation framework
• Next.js - React framework
• PostHog - Product analytics
• Tailwind CSS - Utility-first CSS framework