README.md

Vue-Nuxt-Supabase Starter Project

This is an opinionated starter project that to quickly spin up Nuxt based web projects with Google OAuth, Supabase backend, and client side state management with Pinia.

Features

• Vue.js (latest version) / Nuxt 3
• Supabase for data persistences (PaaS)
• Pinia for state management (with Pinia Persisted State)
• Tailwind CSS for utility-first styling
• Lucide Vue Next for icons
• Vue3-Google-Sign-In for authentication

Prerequisites

• Node.js (version compatible with Nuxt 3)
• npm or yarn

Getting Started

Clone the repository:

git clone [your-repo-url]
cd vue-nuxt-supabase-starter

Install dependencies:

npm install

Setting up Google Sign-In

1. Go to the Google Cloud Console
2. Create a new project or select an existing one
3. Go to the Credentials page
4. Create an OAuth 2.0 Client ID
   • Application type: Web application
   • Add authorized JavaScript origins: https://localhost:3000 (for development)
   • Add authorized redirect URIs: https://localhost:3000 (for development)
5. Copy the Client ID and paste it into your .env file as GOOGLE_CLIENT_ID

Local dev now requires HTTPS. Use mkcert to create local certificates:

Note: Install mkcert using chocolately (Windows) or Homebrew (Mac)

mkcert localhost

Note: nuxt.config.ts is already set up to use the cert during local dev:

export default defineNuxtConfig({
  devServer: {
    https: {
      key: './localhost-key.pem',
      cert: './localhost.pem',
    }
  },

Setting up Supabase

1. Refer to this gist to create a new schema on your Supabase project.

2. Add the variables SUPABASE_URL and SUPABASE_SERVICE_KEY to your .env file

3. Create the users table in your schema:

   CREATE TABLE <schema>.organizations (
    id SERIAL PRIMARY KEY,
    name VARCHAR(255) NOT NULL
   );
   
   -- Insert default organization
   INSERT INTO <schema>.organizations (id, name)
   VALUES (1, 'Default organization');
   
   CREATE TABLE <schema>.users (
   id SERIAL PRIMARY KEY,
   organization_id INTEGER REFERENCES <schema>.organizations(id),
   name VARCHAR(255) NOT NULL,
   email VARCHAR(255) NOT NULL UNIQUE,
   picture VARCHAR(1024),
   created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
   updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
   last_login TIMESTAMPTZ DEFAULT NULL
   );
   
   -- Enable RLS on both tables
   ALTER TABLE <schema>.organizations ENABLE ROW LEVEL SECURITY;
   ALTER TABLE <schema>.users ENABLE ROW LEVEL SECURITY;
   

Note: We default to org_id = 1 in UserService, but modify as needed.

Styling with Tailwind CSS

This project uses Tailwind CSS for styling. Tailwind provides a set of utility classes that you can use directly in your HTML to style your components. To customize your Tailwind setup, you can modify the tailwind.config.js file (if you've created one) or add Tailwind-specific configuration to your nuxt.config.ts file.

Icons with Lucide Vue Next

The project includes Lucide for icons. You can use these icons in your Vue components as needed.

Favicon

To change the title and favicon, update nuxt.config.ts. Create your own favicon at https://favicon.io/ and simply drop overtop of the files in the public folder.

Environment Variables

Create a .env file in the root directory of the project to store secret project variables.

NUXT_PUBLIC_GOOGLE_CLIENT_ID=your_google_client_id
SUPABASE_URL=your_supabase_project_url
SUPABASE_SCHEMA=your_supabase_schema
SUPABASE_KEY=your_supabase_anon_key
SUPABASE_SERVICE_KEY=your_supabase_service_key