SupaSvelteKit โšก

๐ŸŒŸ Where Svelte's elegance meets Supabase's might! ๐ŸŒŸ

SupaSvelteKit is a library designed to seamlessly integrate SvelteKit with Supabase, providing developers with a powerful toolkit to build dynamic web applications.

๐ŸŽ‰ Features

  • Authentication ๐Ÿ”: Easily integrate Supabase authentication with SvelteKit.
  • Realtime โฑ๏ธ: Simplified multi-user realtime updates with Svelte stores.
  • Storage ๐Ÿ“ฆ: Manage your Supabase storage with Svelte components.
  • ... and more to come! Stay tuned and feel free to suggest or contribute new features!

๐Ÿ›  Installation

npm install supasveltekit

๐Ÿš€ Quick Start

  1. Initialize your Supabase client:
    src/lib/supabase.ts ```ts import { PUBLIC_SUPABASE_KEY, PUBLIC_SUPABASE_URL } from '$env/static/public'; import { createClient } from '@supabase/supabase-js';

export const supabaseUrl = PUBLIC_SUPABASE_URL; export const supabaseKey = PUBLIC_SUPABASE_KEY;

export const supabase = createClient(supabaseUrl, supabaseKey);


2. Use SupaSvelteKit components in your SvelteKit app:  
```src/routes/+page.svelte```
```svelte
<script lang="ts">
    import { supabase } from '$lib/supabase';
    import { SupabaseApp, Authenticated, Unauthenticated, RealtimePresence, BucketFilesList } from 'supasveltekit';
</script>

<SupabaseApp {supabase}>
    <Authenticated let:session let:signOut>
        <h1>Welcome, {session?.user?.identities?.[0]?.identity_data?.email}!</h1>
        <button on:click={() => signOut()}>Sign Out</button>

        <BucketFilesList bucketName="test-bucket" path="public/" let:bucketFiles let:error>
            {#if error !== null}
                <div>{error}</div>
            {/if}
            <ul>
                {#each bucketFiles as file}
                    <li>
                        {file.name}
                    </li>
                {/each}
            </ul>
        </BucketFilesList>

        <RealtimePresence channelName="my-channel">
            <div slot="default" let:state let:error let:realtime let:channel let:updateStatus>
                {#if error}
                    <p>Error: {error.message}</p>
                {:else if !state}
                    <p>Loading...</p>
                {:else}
                    <p>Connected to channel {channel?.name}</p>
                    <p>Number of users: {state?.count}</p>
                    <button on:click={() => updateStatus({ status: 'online' })}>Go online</button>
                    <button on:click={() => updateStatus({ status: 'offline' })}>Go offline</button>
                {/if}
            </div>
        </RealtimePresence>
    </Authenticated>

    <Unauthenticated>
        <h1>Sign in to continue</h1>
        <button on:click={() => signIn()}>Sign In</button>
    </Unauthenticated>
</SupabaseApp>

๐Ÿ“š Documentation

For detailed documentation, usage guides, and API references, dive into our documentation site.

๐Ÿ“– Examples

Explore hands-on examples to get a feel for how SupaSvelteKit enhances your projects:

๐Ÿ’ช Contributing

Join the SupaSvelteKit journey! ๐ŸŒ Whether you're fixing bugs, suggesting enhancements, or enriching the documentation, every contribution counts. Dive into our CONTRIBUTING.md to get started.

๐Ÿ“œ License

Freedom with responsibility! SupaSvelteKit is MIT licensed, ensuring open use with acknowledgment.

๐Ÿ™Œ Acknowledgements

A big shoutout ๐Ÿ“ฃ:

  • To the Svelte and Supabase communities for lighting the way with invaluable resources and support.
  • To every coder, contributor, and coffee mug that's been part of this journey. โ˜•

Crafted with ๐Ÿงก by OpenFrenchFries and the amazing contributors. Join us!

Top categories

Loading Svelte Themes