Skip to content

Latest commit

 

History

History
88 lines (66 loc) · 2.87 KB

README.md

File metadata and controls

88 lines (66 loc) · 2.87 KB
Raw

ndd

A robust starter template for Next.js 14, integrated with Drizzle ORM, and . This template provides a quick and seamless option to get up and running quickly

🌟 Features

  • Next.js App Router: The latest version of the popular React framework for server-rendered applications.
  • Drizzle ORM: A modern and efficient ORM to manage database operations.
  • drizzle-zod: plugin for Drizzle ORM that allows you to generate Zod schemas from Drizzle ORM schemas.
  • Postgres: A scalable and serverless relational database.
  • TailwindCSS: A utility-first CSS framework for rapid UI development.
  • Just. D: chill set of React components, built on top of React Aria Components. Plus, it includes Tailwind CSS for sleek styling right out of the box.
  • (Coming Soon!) Server Actions: Utilize the experimental features of Next.js for better server-side operations.
  • (Coming Soon!) UseFormStatus: An experimental hook to manage form states.

🚀 Getting Started

Prerequisites

  • Node.js version 18 or newer
  • Package Manager such as npm, yarn, pnpm, or bun. I personally prefer and suggest using bun!

Use This Template

You can use between manual setup or automated using create-next-app.

Automated Setup

npx create-next-app@latest -e https://github.com/mhmdbhsk/ndd project-name

Manual Setup

  1. Clone the Repository

    git clone https://github.com/mhmdbhsk/ndd.git

  2. Install Dependencies

    yarn install
# or
npm install
# or
pnpm install
# or
bun install

  3. Setup Environment Variables

    • Copy .env.example file as .env.local or .env
    • Set up your local postgres database and assign connection string value to DATABASE_URL in the .env file
    • You can generate secret for next-auth using npx auth secret

  4. Run Migrations

    yarn db:push
# or
npm db:push
# or
pnpm db:push
# or
bun db:push

  5. Start Development Server

    yarn dev
# or
npm run dev
# or
pnpm dev
# or
bun dev

Now, you can open http://localhost:3000 in your browser to see your app in action!

📃 License

This project is MIT licensed.

Reference