Nuxt Mkdirs

Open-source directory website template built with Nuxt 4

English | 简体中文

Live Demo · Documentation · Report Bug

✨ Features

• 🎨 3 Homepage Layouts - Multiple styles, ready to use out of the box
• 📦 Sanity CMS - Headless CMS, no database configuration needed
• 🔐 Multiple Auth Methods - Google / GitHub OAuth login
• 💳 Payment Integration - Supports Stripe and Creem
• 📧 Email Service - Resend for transactional emails + Newsletter
• 🤖 AI Auto-fill - Automatically extract website info with AI
• 🌙 Dark Mode - Auto-follows system theme
• 📱 Responsive Design - Perfect mobile adaptation
• ⚡ NuxtHub Deploy - One-click deploy to Cloudflare

📸 Screenshot

🛠️ Tech Stack

🚀 Quick Start

Prerequisites

• Node.js 18+
• pnpm 8+

Installation

# Clone the repository
git clone https://github.com/PBHAHAHA/Nuxt_Mkdirs.git
cd Nuxt_Mkdirs

# Install dependencies
pnpm install

# Copy environment variables
cp .env.example .env

# Start development server
pnpm dev

Visit http://localhost:3000 to see the result.

Build & Deploy

# Build for production
pnpm build

# Preview locally
pnpm preview

🚀 Deployment

This project uses NuxtHub v0.10+ with Cloudflare Workers.

⚠️ Note: NuxtHub Admin deployment will be deprecated on December 31, 2024. Please use Wrangler for deployment.

Deploy with Wrangler

1. Copy the wrangler configuration:

cp wrangler.example.jsonc wrangler.jsonc

2. Edit wrangler.jsonc and fill in your environment variables.

3. Build and deploy:

pnpm build
npx wrangler deploy

Your site will be deployed to https://nuxt-mkdirs.<your-account>.workers.dev.

To use a custom domain, configure it in Cloudflare Dashboard > Workers & Pages > your project > Settings > Domains & Routes.

⚙️ Configuration Guide

1. Sanity CMS Setup

Nuxt Mkdirs uses Sanity as a headless CMS to manage all content data.

1. Create a Sanity account
2. Create a new project and get the Project ID
3. Create an API Token (select Editor permission)
4. Configure CORS origins

# .env configuration
NUXT_PUBLIC_SANITY_PROJECT_ID=your_project_id
NUXT_PUBLIC_SANITY_DATASET=production
NUXT_SANITY_API_TOKEN=your_api_token

5. Deploy Sanity Studio

pnpm dlx sanity deploy

2. Email Setup (Resend)

1. Create a Resend account
2. Add and verify your domain
3. Create an API Key

4. Configure Audience ID (for Newsletter)

# .env configuration
NUXT_RESEND_API_KEY=re_xxxxx
[email protected]
NUXT_RESEND_AUDIENCE_ID=xxxxx

3. Payment Setup

Stripe (International)

NUXT_STRIPE_SECRET_KEY=sk_xxxxx
NUXT_STRIPE_WEBHOOK_SECRET=whsec_xxxxx
NUXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_xxxxx

Creem (China-friendly)

Creem supports registration with Chinese ID, more friendly for Chinese developers.

NUXT_CREEM_API_KEY=xxxxx
NUXT_CREEM_WEBHOOK_SECRET=xxxxx
NUXT_CREEM_TEST_MODE=true
NUXT_PUBLIC_CREEM_PRO_PRODUCT_ID=xxxxx

4. OAuth Authentication Setup

Google OAuth

1. Visit Google Cloud Console
2. Create an OAuth Client ID

# .env configuration
NUXT_AUTH_GOOGLE_CLIENT_ID=xxxxx
NUXT_AUTH_GOOGLE_CLIENT_SECRET=xxxxx

GitHub OAuth

1. Visit GitHub Developer Settings
2. Create an OAuth App

NUXT_AUTH_GITHUB_CLIENT_ID=xxxxx
NUXT_AUTH_GITHUB_CLIENT_SECRET=xxxxx

Auth Secret

# Generate secret
openssl rand -base64 32

# .env configuration
NUXT_AUTH_SECRET=your_generated_secret

5. AI Configuration (Optional)

Enable AI-powered auto-fill feature for website submissions.

# Choose AI provider: google, deepseek, openai
NUXT_AI_PROVIDER=google

# Google Generative AI (https://aistudio.google.com/apikey)
NUXT_GOOGLE_AI_API_KEY=xxxxx

# DeepSeek (https://platform.deepseek.com/api_keys)
NUXT_DEEPSEEK_API_KEY=xxxxx

# OpenAI (https://platform.openai.com/settings/organization/api-keys)
NUXT_OPENAI_API_KEY=xxxxx

When configured, users can click the "AI Auto-fill" button to automatically:

• Extract website name and description
• Generate detailed introduction
• Download and upload logo/images
• Suggest categories and tags

📁 Project Structure

nuxt-mkdirs/
├── app/
│   ├── components/     # Vue components
│   ├── composables/    # Composables
│   ├── layouts/        # Layout components
│   ├── pages/          # Page routes
│   └── utils/          # Utility functions
├── server/
│   ├── api/            # API routes
│   └── utils/          # Server utilities
├── sanity/
│   └── schemas/        # Sanity schemas
└── public/             # Static assets

🤝 Contributing

Contributions are welcome! Please read the Contributing Guide.

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

📄 License

This project is licensed under the MIT License.

💖 Support

If this project helps you, please consider:

• ⭐ Give it a Star
• 🐛 Submit Issues
• 📢 Share with others
• 

📮 Contact

• GitHub: @PBHAHAHA