-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add supabase example and persistence adapter
- Loading branch information
Showing
20 changed files
with
1,479 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| head: | ||
| - - link | ||
| - rel: canonical | ||
| href: https://signaldb.js.org/data-persistence/supabase/ | ||
| --- | ||
| # Supabase Persistence Adapter | ||
|
|
||
| In the evolving world of web applications, the importance of data persistence and consistency cannot be overstated. While SignalDB excels as an efficient in-memory database, it faces the risk of data loss during events like page reloads. Addressing this challenge, the integration of persistence adapters, such as one for Supabase, becomes critical. Supabase, an open-source Firebase alternative, provides a suite of powerful features that can significantly augment SignalDB's functionality. Incorporating a Supabase persistence adapter ensures not only the persistence of data within SignalDB but also enables seamless interaction with Supabase’s real-time database and authentication services. | ||
|
|
||
| The role of persistence adapters within SignalDB is to facilitate a connection between SignalDB and various storage solutions, in this case, Supabase’s PostgreSQL database and storage services. These adapters convert the high-level data operations of applications into low-level operations that are compatible with Supabase's storage system. With a Supabase persistence adapter integrated, developers can leverage the platform's capabilities, including real-time data updates, secure user authentication, and efficient data storage, aligning them with SignalDB’s in-memory data handling. The aim is to utilize the persistence adapter for storing and managing data within the robust framework of Supabase. | ||
|
|
||
| One of the main advantages of using a Supabase persistence adapter is the substantial level of flexibility and abstraction it provides. It enables SignalDB to interact fluidly with Supabase's comprehensive backend services, ensuring uninterrupted data continuity even in scenarios involving application reloads or extended user sessions. Moreover, decoupling SignalDB from its storage medium through the adapter simplifies transitioning to different storage systems or updating backend services, requiring minimal code adjustments. In essence, a Supabase persistence adapter functions as a vital bridge, connecting SignalDB’s in-memory functionalities with Supabase’s persistent data storage and backend capabilities. | ||
|
|
||
| For a practical demonstration, our [Supabase Example](https://github.com/maxnowack/signaldb/tree/main/examples/supabase) showcases a basic yet functional implementation of a persistence adapter for Supabase. The helper function for crafting a Supabase persistence adapter for a SignalCollection is available here: [`createSupabasePersistenceAdapter`](https://github.com/maxnowack/signaldb/blob/main/examples/supabase/src/utils/createSupabasePersistenceAdapter.ts), with its usage illustrated [here](https://github.com/maxnowack/signaldb/blob/main/examples/supabase/src/system/setupCollection/persistence.ts). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
| /.pnp | ||
| .pnp.js | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # next.js | ||
| /.next/ | ||
| /out/ | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| *.pem | ||
|
|
||
| # debug | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
||
| # local env files | ||
| .env*.local | ||
|
|
||
| # vercel | ||
| .vercel | ||
|
|
||
| # typescript | ||
| *.tsbuildinfo | ||
| next-env.d.ts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| First, run the development server: | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| # or | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
|
|
||
| You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. | ||
|
|
||
| This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
|
|
||
| ## Learn More | ||
|
|
||
| To learn more about Next.js, take a look at the following resources: | ||
|
|
||
| - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. | ||
| - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
|
|
||
| You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
|
|
||
| ## Deploy on Vercel | ||
|
|
||
| The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
|
|
||
| Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| /** @type {import('next').NextConfig} */ | ||
| const nextConfig = { | ||
| basePath: '/examples/supabase', | ||
| output: 'export', | ||
| eslint: { | ||
| ignoreDuringBuilds: true, | ||
| }, | ||
| typescript: { | ||
| ignoreBuildErrors: true, | ||
| }, | ||
| } | ||
|
|
||
| module.exports = nextConfig |
Oops, something went wrong.