40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
# Privy Auth `create-next-app` Starter
|
|
|
|
This is a template for integrating [**Privy Auth**](https://www.privy.io/) into a [NextJS](https://nextjs.org/) project. Check out the deployed app [here](https://create-next-app.privy.io/)!
|
|
|
|
This demo uses NextJS's [Pages Router](https://nextjs.org/docs/pages/building-your-application/routing). If you'd like to see an example using the [App Router](https://nextjs.org/docs/app), just change the branch of this repository to [`app-router`](https://github.com/privy-io/create-next-app/tree/app-router).
|
|
|
|
## Setup
|
|
|
|
1. Clone this repository and open it in your terminal.
|
|
```sh
|
|
git clone https://github.com/privy-io/create-next-app
|
|
```
|
|
|
|
2. Install the necessary dependencies (including [Privy Auth](https://www.npmjs.com/package/@privy-io/react-auth)) with `npm`.
|
|
```sh
|
|
npm i
|
|
```
|
|
|
|
3. Initialize your environment variables by copying the `.env.example` file to an `.env.local` file. Then, in `.env.local`, [paste your Privy App ID from the dashboard](https://docs.privy.io/guide/dashboard/api-keys).
|
|
```sh
|
|
# In your terminal, create .env.local from .env.example
|
|
cp .env.example .env.local
|
|
|
|
# Add your Privy App ID to .env.local
|
|
NEXT_PUBLIC_PRIVY_APP_ID=<your-privy-app-id>
|
|
```
|
|
|
|
## Building locally
|
|
|
|
In your project directory, run `npm run dev`. You can now visit http://localhost:3000 to see your app and login with Privy!
|
|
|
|
|
|
## Check out:
|
|
- `pages/_app.tsx` for how to use the `PrivyProvider` and initialize it with your Privy App ID
|
|
- `pages/index.tsx` for how to use the `usePrivy` hook and implement a simple `login` button
|
|
- `pages/dashboard.tsx` for how to use the `usePrivy` hook, fields like `ready`, `authenticated`, and `user`, and methods like `linkWallet` and `logout`
|
|
|
|
|
|
**Check out [our docs](https://docs.privy.io/) for more guidance around using Privy in your app!**
|