README.md

Remix and Supabase Starter Kit

The fastest way to build apps with Remix and Supabase

Features · Clone and run locally · Feedback and issues More Examples

Features

• Works across the entire Remix stack
  • Loaders
  • Actions
  • Auth
  • Client
  • Server
  • It just works!
• supabase-ssr. A package to configure Supabase Auth to use cookies
• Styling with Tailwind CSS
• Components with shadcn/ui

Clone and run locally

1. You'll first need a Supabase project which can be made via the Supabase dashboard

2. Create a Remix app using the Supabase Starter template npx command

   npx create-remix@latest --template https://github.com/saltcod/remix-quickstart

3. Use cd to change into the app's directory

   cd name-of-new-app

4. Rename .env.example to .env.local and update the following:

   SUPABASE_URL=[INSERT SUPABASE PROJECT URL]
   SUPABASE_ANON_KEY=[INSERT SUPABASE PROJECT API ANON KEY]
   

   Both SUPABASE_URL and SUPABASE_ANON_KEY can be found in your Supabase project's API settings

5. You can now run the Remix local development server:

   npm run dev

   The starter kit should now be running on localhost:5173.

6. This template comes with the default shadcn/ui style initialized. If you instead want other ui.shadcn styles, delete components.json and re-install shadcn/ui

Check out the docs for Local Development to also run Supabase locally.

Feedback and issues

Please file feedback and issues over on the Supabase GitHub org.