Skip to content

Latest commit

 

History

History
107 lines (79 loc) · 4.3 KB

README.md

File metadata and controls

107 lines (79 loc) · 4.3 KB

🚀 Next Faster

Rapid development with Next.js 15, TypeScript, and Shadcn UI, Swagger. Built for developers who want to move fast without compromising on quality.

🛠 Technologies

Frontend

  • Next.js 15 (App Router)
  • TypeScript 5
  • TailwindCSS 3
  • Shadcn UI
  • Swagger UI

Backend & Database

  • Nextjs API Routes & Server Action
  • Prisma ORM
  • Supabase Auth & PostgreSQL

Development Tools

  • Dev Containers
  • Format & Linting
  • Pre-commit hooks
  • Semantic Release
  • Some rules & memory for Cline, RooCode

Core Features

  • Dev Containers: Pre-configured development environment with Development Container.
  • Code Quality: Pre-configured with Biomejs, commitlint (follow Conventional Commit), pre-commit hooks with Husky & lint-staged.
  • Common UI Components: Shadcn UI components for rapid development, but you can use another components UI.
  • Light/Dark Mode: Theme switching based on user preference with next-themes.
  • Multi Language: Internationalization (i18n) support for multiple languages with next-intl.
  • OAuth2: Authentication with Supabase.
  • API Documentation: Generated API documentation using Swagger UI.
  • Auto Release: Automated release process with Semantic Release.
  • Vercel Deployment: One-click deployment to Vercel.

Getting Started

Option 1: Development Container (Recommended)

Choose your preferred Development Container environment:

Open in Dev Containers Open in GitHub Codespaces Open in Gitpod

This automatically sets up your development environment with all dependencies installed. Remember setup your environment variables based on the platform you choose.

Option 2: Local Development

git clone [email protected]:holedev/nextjs-faster.git
cd nextjs-faster

# use correct version node (optional)
nvm use

# use correct version pnpm (optional)
corepack enable pnpm

# setup environment variables
cp .env.example .env

# install dependencies
pnpm i

# dev
pnpm dev

🌐 Deployment

Vercel (Recommended)

Deploy with Vercel

Docker

docker compose up

📁 Project Structure

├── app/                 # Next.js app directory
│   ├── [locale]/       # i18n routes
│   ├── api/            # API endpoints
│   └── api-docs/       # Swagger UI
├── components/         # React components
│   ├── custom/        # Project components
│   └── ui/            # Shadcn UI components
└── configs/           # Configuration
    ├── data/         # Sample data
    ├── i18n/         # i18n config
    ├── messages/     # Translation files
    ├── prisma/       # Database schema
    ├── supabase/     # Auth config
    └── swagger/      # API documentation

📝 License

MIT License - fork, modify and use as you wish.

👨‍💻 Author

@holedev