https://github.com/d3sc/nextbase

next js with supabase
https://github.com/d3sc/nextbase

Last synced: 21 days ago
JSON representation

next js with supabase

• Host: GitHub
• URL: https://github.com/d3sc/nextbase
• Owner: d3sc
• Created: 2024-06-21T09:18:21.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-24T16:05:49.000Z (6 months ago)
• Last Synced: 2024-06-24T18:02:14.901Z (6 months ago)
• Language: TypeScript
• Homepage: https://nextbase-mu.vercel.app
• Size: 328 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  
Next.js and Supabase Starter Kit






 The fastest way to build apps with Next.js and Supabase





  Features ·

  Demo ·

  Deploy to Vercel ·

  Clone and run locally ·

  Feedback and issues

  More Examples






## 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.

[![Deploy with Vercel](https://vercel.com/button)](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)