https://github.com/aliazlanpro/nextjs-starter

A Next.js starter
https://github.com/aliazlanpro/nextjs-starter

drizzle-orm honojs next-auth nextjs pg postgresql shadcn-ui tailwindcss tanstack-query

Last synced: 4 days ago
JSON representation

A Next.js starter

• Host: GitHub
• URL: https://github.com/aliazlanpro/nextjs-starter
• Owner: aliazlanpro
• License: mit
• Created: 2024-06-04T14:21:28.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-12-11T10:34:05.000Z (12 days ago)
• Last Synced: 2024-12-11T11:34:42.724Z (12 days ago)
• Topics: drizzle-orm, honojs, next-auth, nextjs, pg, postgresql, shadcn-ui, tailwindcss, tanstack-query
• Language: TypeScript
• Homepage:
• Size: 456 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Next.js Starter Template

This starter template is designed to quickly bootstrap Next.js projects with a robust set of features and tools.

Developed by [Ali Azlan](https://aliazlan.me)

## Features

- 🌓 Dark Mode with toggle button

- 🚀 Loading Global Progress Bar

- 🔄 Hono + Tanstack React Query for efficient data fetching and mutation

- 🔐 Better-auth with Google OAuth and Logout functionality

- 🎨 Shadcn UI for beautiful, customizable components

- 🗃️ Drizzle ORM for type-safe database operations

- 🔧 Environment variable handling with @t3-oss/env-nextjs

- 🐘 PostgreSQL support via 'pg' package

## Tech Stack

- ⚛️ Next.js - React framework for production

- 🎨 Tailwind CSS - Utility-first CSS framework

- 🔒 Better-auth - Authentication for Next.js

- 🗄️ Drizzle ORM - TypeScript ORM for SQL databases

- 🧰 Shadcn UI - Re-usable components built with Radix UI and Tailwind CSS

## Environment Variables

To run this project, you will need to add the following environment variables to your .env file. A sample `.env.example` file is provided in the repository:

- `POSTGRES_URL`: Your PostgreSQL database URL

- `PG_SSL`: PostgreSQL SSL Certificate (if required)

- `BETTER_AUTH_SECRET`: Better-auth secret key

- `BETTER_AUTH_URL`: Better-auth URL (e.g., http://localhost:3000)

- `AUTH_GOOGLE_ID`: Google OAuth Client ID

- `AUTH_GOOGLE_SECRET`: Google OAuth Client Secret

- `NEXT_PUBLIC_AUTH_GOOGLE_ID`: Google OAuth Client ID (for Google One Tap)

- `NEXT_PUBLIC_APP_URL`: Public URL of your app (e.g., http://localhost:3000)

## Getting Started

1. Clone the repository

2. Install dependencies with `npm install`

3. Set up your environment variables:

   - Copy the `.env.example` file to `.env`

   - Fill in the required environment variables in the `.env` file

4. Run the development server with `npm run dev`

Visit [http://localhost:3000](http://localhost:3000) to see your application in action.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is open source and available under the [MIT License](LICENSE).