Skip to content

A Next.js App Router starter project with TypeScript, Tailwind, NextAuth, Zustand, OG meta tags, and Dark Mode.

License

Notifications You must be signed in to change notification settings

amirardalan/startup

Repository files navigation

Startup

This is a Next.js App Router project with various features and utilities to quickly bootstrap a web app.

Features

  • Autentication with Auth.js
  • State management with Zustand
  • Light, Dark, and System Theme toggle
  • Prettier code formatting with Tailwind plugin
  • CLSX for improved logic within className
  • Next.js optimized fonts
  • Dynamic theme-based favicon
  • Dynamic Metadata and Page Titles
  • Route-based active navigation highlighting
  • Dynamic footer copyright date
  • Tooltip component
  • OG Image metadata
  • Dynamically-generated sitemap.xml

Getting Started

Setup

npm install

Then, set up your GitHub oAuth App and add your GitHub Client ID and Secret in a .env.local file:

// .env.local
NEXT_PUBLIC_APP_URL="http://localhost:3000"

AUTH_GITHUB_ID=<GitHub Client ID>
AUTH_GITHUB_SECRET=<GitHub Client Secret>

AUTH_TRUST_HOST=NEXT_PUBLIC_APP_URL
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=<Next Auth Secret>

And finally, generate a Next Auth secret which will automatically overwrite the placeholder in the .env.local file:

npx auth secret

Run

npm run dev

About

A Next.js App Router starter project with TypeScript, Tailwind, NextAuth, Zustand, OG meta tags, and Dark Mode.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published