An open API service indexing awesome lists of open source software.

https://github.com/pnvdev/nextjs-supabase-starter


https://github.com/pnvdev/nextjs-supabase-starter

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

# โšก Next.js + Supabase Starter

A minimal and powerful starter template combining **Next.js** and **Supabase** โ€“ perfect for building modern full-stack applications with authentication, database, and storage out of the box.

![Screenshot](./public/preview.png)

## ๐Ÿš€ Features

- ๐Ÿ” Supabase Auth (Email/Password, Social logins)
- ๐Ÿ—ƒ๏ธ Supabase Database & API integration
- ๐Ÿ“ฆ Fully typed with TypeScript
- ๐ŸŒ— Dark mode support (optional)
- ๐Ÿ’จ Tailwind CSS for rapid UI styling
- ๐Ÿงช Ready for testing and deployment

## ๐Ÿ›  Tech Stack

- [Next.js](https://nextjs.org/)
- [Supabase](https://supabase.com/)
- [Tailwind CSS](https://tailwindcss.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [React](https://reactjs.org/)

## ๐Ÿ“ฆ Getting Started

### 1. Clone the repo

```bash
git clone https://github.com/pnvdev/nextjs-supabase-starter.git
cd nextjs-supabase-starter
```

### 2. Install dependencies

```bash
npm install
# or
yarn
```

### 3. Setup Supabase

1. Create a new project at [supabase.com](https://supabase.com)
2. Grab your **Project URL** and **anon/public API key**
3. Create a `.env.local` file:

```bash
NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
```

> โœ… You can also configure `SUPABASE_SERVICE_ROLE_KEY` if needed for admin actions (be careful with exposure).

### 4. Run locally

```bash
npm run dev
# or
yarn dev
```

Visit `http://localhost:3000` to see the app in action.

## ๐ŸŒ Deployment

This starter works great on platforms like [Vercel](https://vercel.com/) or [Netlify](https://netlify.com/).

> Make sure to add the environment variables in the dashboard when deploying.

## ๐Ÿ—‚๏ธ Project Structure

```
.
โ”œโ”€โ”€ components/ # Reusable UI elements
โ”œโ”€โ”€ lib/ # Supabase client setup
โ”œโ”€โ”€ pages/ # Next.js routes
โ”œโ”€โ”€ styles/ # Tailwind/global styles
โ”œโ”€โ”€ types/ # TypeScript types
โ”œโ”€โ”€ .env.local # Local env variables
```

## ๐Ÿ“Œ TODO / Ideas

- [ ] Supabase Row-Level Security (RLS) examples
- [ ] User profile dashboard
- [ ] SSR/ISR support
- [ ] Dark mode switcher
- [ ] Example with storage uploads

## ๐Ÿค Contributing

Contributions are welcome! Feel free to fork the repo, open issues, or submit pull requests.

## ๐Ÿ“„ License

[MIT](LICENSE)

---

Built with โค๏ธ by [pnvdev](https://github.com/pnvdev)