diff --git a/demo/nextjs/README.md b/demo/nextjs/README.md index e215bc4c..5519e6e7 100644 --- a/demo/nextjs/README.md +++ b/demo/nextjs/README.md @@ -1,8 +1,43 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). +# Better Auth Demo App + +Welcome to the Better Auth demo app! This project is built with [Next.js](https://nextjs.org) using [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). ## Getting Started -First, run the development server: +Here’s how you can get the app running locally: + +### Prerequisites + +1. **Clone the repo**: + + ```bash + git clone https://github.com/better-auth/better-auth + cd better-auth/demo/nextjs + ``` + +2. **Install the dependencies**: + + ```bash + npm install + # or + yarn install + # or + pnpm install + ``` + +3. **Set up your environment variables**: + + - Rename the `.env.example` file to `.env`: + + ```bash + mv .env.example .env + ``` + + - Open `.env` and fill in the required details. These will include things like API URLs, client IDs, and secrets needed to connect to the Better Auth service. + +### Start the Development Server + +Once everything is set up, start the development server with: ```bash npm run dev @@ -14,23 +49,35 @@ pnpm dev bun dev ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +The app will be live at [http://localhost:3000](http://localhost:3000). Open it in your browser, and you’re good to go! -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +Feel free to jump in and edit the app by modifying `app/page.tsx`. Any changes you make will update automatically in the browser. -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. +## Features + +Here’s what this app supports out of the box: + +- **[Email & Password](https://www.better-auth.com/docs/basic-usage#email-password)**: Simple and secure authentication. +- **[Organization / Teams](https://www.better-auth.com/docs/plugins/organization)**: Manage users within organizations or teams. +- **[Passkeys](https://www.better-auth.com/docs/plugins/passkey)**: Passwordless login using modern authentication standards. +- **[Multi-Factor Authentication (MFA)](https://www.better-auth.com/docs/plugins/2fa)**: Add an extra layer of security. +- **[Password Reset](https://www.better-auth.com/docs/concepts/email#password-reset-email)**: Let users reset their passwords if they forget them. +- **[Email Verification](https://www.better-auth.com/docs/concepts/email#email-verification)**: Ensure users verify their email addresses. +- **[Roles & Permissions](https://www.better-auth.com/docs/plugins/admin#role)**: Define and manage who can do what. +- **[Rate Limiting](https://www.better-auth.com/docs/concepts/rate-limit)**: Protect your app from abuse with smart limits. +- **[Session Management](https://www.better-auth.com/docs/concepts/session-management)**: Handle user sessions seamlessly. +- **[Stripe Plugin](https://www.better-auth.com/docs/plugins/stripe)**: Integrate Stripe for customer management, subscriptions, and webhooks. ## Learn More -To learn more about Next.js, take a look at the following resources: +Here are some helpful links if you want to dive deeper: -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +- [Better Auth Documentation](https://better-auth.com/docs) - Everything you need to know to integrate Better Auth. +- [Next.js Documentation](https://nextjs.org/docs) - Learn about the framework we used to build this app. +- [Learn Next.js](https://nextjs.org/learn) - A hands-on tutorial for Next.js. -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! +--- -## Deploy on Vercel +If you run into issues or have suggestions, feel free to open an issue or submit a pull request on the [GitHub repo](https://github.com/better-auth/better-auth). -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +Happy coding!