An open API service indexing awesome lists of open source software.

https://github.com/diwashbhattarai999/nextstarter

๐Ÿš€ Next.js Template: A streamlined template for Next.js projects
https://github.com/diwashbhattarai999/nextstarter

commitlint eslint github-actions husky lint-staged next-theme nextjs postgresql prettier prisma tailwind typescript

Last synced: 3 months ago
JSON representation

๐Ÿš€ Next.js Template: A streamlined template for Next.js projects

Awesome Lists containing this project

README

        

# Next.js Template - NextStarter

![Next.js](https://img.shields.io/badge/Next.js-14-green)
![NextAuth](https://img.shields.io/badge/NextAuth-v5-blue)
![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-3.0-blueviolet)
![ESLint](https://img.shields.io/badge/ESLint-Configured-yellow)
![Prettier](https://img.shields.io/badge/Prettier-Configured-lightgrey)
![Commitlint](https://img.shields.io/badge/Commitlint-Configured-orange)
![Husky](https://img.shields.io/badge/Husky-Configured-red)
![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-Configured-success)

Kickstart your Next.js projects with this template featuring authentication using NextAuth v5, Tailwind CSS for styling, and the latest Next.js 14. It comes pre-configured with ESLint, Prettier, Commitlint and Husky for a solid development setup. Perfect for modern, secure web applications.

> [!WARNING]
> This app is a work in progress

## Features

- ๐Ÿš€ [Next.js](https://nextjs.org) with App Router
- โœ… Type checking [TypeScript](https://www.typescriptlang.org)
- ๐ŸŽจ Integrate with [Tailwind CSS](https://tailwindcss.com)
- ๐Ÿ”’ Authentication with NextAuth v5 [Auth.js](https://authjs.dev/getting-started/installation?framework=next.js): Sign up, Sign in, Sign out, Forgot password, Reset password, and more.
- ๐Ÿ”„ Social Auth (Google & GitHub)
- ๐Ÿ’ผ Type-safe ORM with [PrismaORM](https://www.prisma.io/) and [PostgreSQL](https://www.postgresql.org/)
- ๐Ÿ“ Form with [React Hook From](https://react-hook-form.com/get-started)
- ๐Ÿ” Validation library with [Zod](https://zod.dev/)
- ๐Ÿงน Linter with [ESLint](https://eslint.org)
- ๐Ÿ–Œ๏ธ Code Formatter with [Prettier](https://prettier.io)
- ๐Ÿถ Husky for Git Hooks
- ๐ŸŽฏ Lint-staged for running linters on Git staged files
- ๐Ÿ” Lint git commit with Commitlint
- ๐Ÿš€ Run tests on pull request with GitHub Actions
- ๐Ÿ“‚ Absolute Imports using `@` prefix
- ๐Ÿ” SEO metadata, Sitemap.xml and robots.txt with next-sitemap
- ๐Ÿ“ˆ Maximize lighthouse score\
- ๐Ÿ›Ž๏ธ Sonner for toasts
- ๐Ÿ“ค Uploadthing for file uploads
- ๐ŸŽจ Lucide-react for icons
- ๐ŸŒ— Next-themes for dark and light mode
- ๐Ÿ”„ Next-js-toploader for smooth page transitions
- ๐Ÿ“ง Resend for sending email
- ๐ŸŒ Multi-language (i18n) with [next-intl](https://next-intl-docs.vercel.app/) (Unstable)

## Features to be implemented (Soon):

- [ ] Payment Integration with esewa, khalti, stripe (anyone or maybe all)
- [ ] Framer motion or gsap for animation
- [ ] Analytics

## Getting Started

1. Clone the repository:

```sh
pnpm create next-app --example "https://github.com/diwashbhattarai999/NextStarter"
```

2. Install dependencies using pnpm:

```sh
pnpm install
```

3. Copy `.env.example` to `.env.local` or `.env` and update the variables.

```sh
cp .env.example .env
```

4. Start the development server:

```sh
pnpm dev
```

5. Open [http://localhost:3000](http://localhost:3000) in your browser

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.