c380d91562
<!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> Nothing too crazy, just pointing the demo to the right URL. The previous URL is dead/unreachable. 💖
93 lines
4.2 KiB
Markdown
93 lines
4.2 KiB
Markdown
<a href="https://demo-nextjs-with-supabase.vercel.app/">
|
|
<img alt="Next.js and Supabase Starter Kit - the fastest way to build apps with Next.js and Supabase" src="https://demo-nextjs-with-supabase.vercel.app/opengraph-image.png">
|
|
<h1 align="center">Next.js and Supabase Starter Kit</h1>
|
|
</a>
|
|
|
|
<p align="center">
|
|
The fastest way to build apps with Next.js and Supabase
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#features"><strong>Features</strong></a> ·
|
|
<a href="#demo"><strong>Demo</strong></a> ·
|
|
<a href="#deploy-to-vercel"><strong>Deploy to Vercel</strong></a> ·
|
|
<a href="#clone-and-run-locally"><strong>Clone and run locally</strong></a> ·
|
|
<a href="#feedback-and-issues"><strong>Feedback and issues</strong></a>
|
|
<a href="#more-supabase-examples"><strong>More Examples</strong></a>
|
|
</p>
|
|
<br/>
|
|
|
|
## Features
|
|
|
|
- Works across the entire [Next.js](https://nextjs.org) stack
|
|
- App Router
|
|
- Pages Router
|
|
- Middleware
|
|
- Client
|
|
- Server
|
|
- It just works!
|
|
- supabase-ssr. A package to configure Supabase Auth to use cookies
|
|
- Styling with [Tailwind CSS](https://tailwindcss.com)
|
|
- Optional deployment with [Supabase Vercel Integration and Vercel deploy](#deploy-your-own)
|
|
- Environment variables automatically assigned to Vercel project
|
|
|
|
## Demo
|
|
|
|
You can view a fully working demo at [demo-nextjs-with-supabase.vercel.app](https://demo-nextjs-with-supabase.vercel.app/).
|
|
|
|
## Deploy to Vercel
|
|
|
|
Vercel deployment will guide you through creating a Supabase account and project.
|
|
|
|
After installation of the Supabase integration, all relevant environment variables will be assigned to the project so the deployment is fully functioning.
|
|
|
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&project-name=nextjs-with-supabase&repository-name=nextjs-with-supabase&demo-title=nextjs-with-supabase&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2Fopengraph-image.png&integration-ids=oac_VqOgBHqhEoFTPzGkPd7L0iH6)
|
|
|
|
The above will also clone the Starter kit to your GitHub, you can clone that locally and develop locally.
|
|
|
|
If you wish to just develop locally and not deploy to Vercel, [follow the steps below](#clone-and-run-locally).
|
|
|
|
## Clone and run locally
|
|
|
|
1. You'll first need a Supabase project which can be made [via the Supabase dashboard](https://database.new)
|
|
|
|
2. Create a Next.js app using the Supabase Starter template npx command
|
|
|
|
```bash
|
|
npx create-next-app -e with-supabase
|
|
```
|
|
|
|
3. Use `cd` to change into the app's directory
|
|
|
|
```bash
|
|
cd name-of-new-app
|
|
```
|
|
|
|
4. Rename `.env.local.example` to `.env.local` and update the following:
|
|
|
|
```
|
|
NEXT_PUBLIC_SUPABASE_URL=[INSERT SUPABASE PROJECT URL]
|
|
NEXT_PUBLIC_SUPABASE_ANON_KEY=[INSERT SUPABASE PROJECT API ANON KEY]
|
|
```
|
|
|
|
Both `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY` can be found in [your Supabase project's API settings](https://app.supabase.com/project/_/settings/api)
|
|
|
|
5. You can now run the Next.js local development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
The starter kit should now be running on [localhost:3000](http://localhost:3000/).
|
|
|
|
> Check out [the docs for Local Development](https://supabase.com/docs/guides/getting-started/local-development) to also run Supabase locally.
|
|
|
|
## Feedback and issues
|
|
|
|
Please file feedback and issues over on the [Supabase GitHub org](https://github.com/supabase/supabase/issues/new/choose).
|
|
|
|
## More Supabase examples
|
|
|
|
- [Next.js Subscription Payments Starter](https://github.com/vercel/nextjs-subscription-payments)
|
|
- [Cookie-based Auth and the Next.js 13 App Router (free course)](https://youtube.com/playlist?list=PL5S4mPUpp4OtMhpnp93EFSo42iQ40XjbF)
|
|
- [Supabase Auth and the Next.js App Router](https://github.com/supabase/supabase/tree/master/examples/auth/nextjs)
|