https://github.com/embium/next-lucia-auth
https://github.com/embium/next-lucia-auth
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/embium/next-lucia-auth
- Owner: embium
- License: mit
- Created: 2024-02-17T18:28:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-03T17:15:27.000Z (about 1 year ago)
- Last Synced: 2025-01-30T12:14:06.546Z (3 months ago)
- Language: TypeScript
- Homepage: https://next-lucia-auth-phi.vercel.app
- Size: 588 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 Auth Starter Template
## Motivation
Implementing authentication in Next.js, especially Email+Password authentication, can be challenging. NextAuth intentionally limits email password functionality to discourage the use of passwords due to security risks and added complexity. However, in certain projects, clients may require user password authentication. Lucia offers a flexible alternative to NextAuth.js, providing more customization options without compromising on security. This template serves as a starting point for building a Next.js app with Lucia authentication.
## Lucia vs. NextAuth.js
Lucia is less opinionated than NextAuth, offering greater flexibility for customization. While Lucia involves more setup, it provides a higher degree of flexibility, making it a suitable choice for projects requiring unique authentication configurations.
## Key Features
- **Authentication:** 💼 Support for Credential and OAuth authentication.
- **Authorization:** 🔒 Easily manage public and protected routes within the `app directory`.
- **Email Verification:** 📧 Verify user identities through email.
- **Password Reset:** 🔑 Streamline password resets by sending email password reset links.
- **Lucia + tRPC:** 🔄 Similar to NextAuth with tRPC, granting access to sessions and user information through tRPC procedures.
- **Stripe Payment:** 💳 Setup user subscriptions seamlessly with stripe.
- **Email template with react-email:** ✉️ Craft your email templates using React.
- **MySQL Database:** 🛢️ Utilize a MySQL database (Planetscale) set up using Drizzle for enhanced performance and type safety.
- **Database Migration:** 🚀 Included migration script to extend the database schema according to your project needs.
## Tech Stack
- [Next.js](https://nextjs.org)
- [Lucia](https://lucia-auth.com/)
- [tRPC](https://trpc.io)
- [Drizzle ORM](https://orm.drizzle.team/)
- [Planetscale](https://planetscale.com/)
- [Stripe](https://stripe.com/)
- [Tailwind CSS](https://tailwindcss.com)
- [Shadcn UI](https://ui.shadcn.com/)
- [React Hook Form](https://www.react-hook-form.com/)
- [React Email](https://react.email/)
## Get Started
1. Clone this repository to your local machine.
2. Copy `.env.example` to `.env` and fill in the required environment variables.
3. Run `pnpm install` to install dependencies.
4. Update app title, database prefix, and other parameters in the `src/lib/constants.ts` file.
5. Run `pnpm db:push` to push your schema to the database.
6. Execute `pnpm dev` to start the development server and enjoy!
## Roadmap
- [ ] Update Password
- [x] Stripe Integration
- [ ] API Rate-Limiting
- [ ] Admin Dashboard (under consideration)
- [ ] Role-Based Access Policy (under consideration)
## Contributing
If you wish to contribute, fork the repository and use a feature branch. Pull requests are warmly welcome.