docs: add appwrite example and persistence adapter

.eslintrc.js

@@ -22,12 +22,9 @@ module.exports = {
     'coverage',
     'docs/.vitepress/dist',
     'docs/public/examples',
-    'examples/rxdb/.next',
-    'examples/rxdb/out',
-    'examples/rxdb/node_modules',
-    'examples/firebase/.next',
-    'examples/firebase/out',
-    'examples/firebase/node_modules',
+    'examples/*/.next',
+    'examples/*/out',
+    'examples/*/node_modules',
   ],
   settings: {
     'import/resolver': {

.github/workflows/checks.yaml

@@ -33,6 +33,7 @@ jobs:
             node_modules
             examples/rxdb/node_modules
             examples/firebase/node_modules
+            examples/appwrite/node_modules
           key: ${{ runner.OS }}-modules-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.OS }}-modules-${{ matrix.node-version }}-
@@ -41,6 +42,7 @@ jobs:
           npm install --no-audit --force --loglevel=error --no-update-notifier
           (cd examples/rxdb && npm install --no-audit --force --loglevel=error --no-update-notifier)
           (cd examples/firebase && npm install --no-audit --force --loglevel=error --no-update-notifier)
+          (cd examples/appwrite && npm install --no-audit --force --loglevel=error --no-update-notifier)
 
   linting:
     needs: preflight
@@ -61,6 +63,7 @@ jobs:
             node_modules
             examples/rxdb/node_modules
             examples/firebase/node_modules
+            examples/appwrite/node_modules
           key: ${{ runner.OS }}-modules-20.x-${{ hashFiles('**/package-lock.json') }}
       - name: linting
         run: |
@@ -85,6 +88,7 @@ jobs:
             node_modules
             examples/rxdb/node_modules
             examples/firebase/node_modules
+            examples/appwrite/node_modules
           key: ${{ runner.OS }}-modules-20.x-${{ hashFiles('**/package-lock.json') }}
       - name: typecheck
         run: |
@@ -112,6 +116,7 @@ jobs:
             node_modules
             examples/rxdb/node_modules
             examples/firebase/node_modules
+            examples/appwrite/node_modules
           key: ${{ runner.OS }}-modules-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - name: unit testing
         run: |
@@ -143,6 +148,7 @@ jobs:
             node_modules
             examples/rxdb/node_modules
             examples/firebase/node_modules
+            examples/appwrite/node_modules
           key: ${{ runner.OS }}-modules-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - name: build package
         run: |
@@ -167,6 +173,7 @@ jobs:
             node_modules
             examples/rxdb/node_modules
             examples/firebase/node_modules
+            examples/appwrite/node_modules
           key: ${{ runner.OS }}-modules-20.x-${{ hashFiles('**/package-lock.json') }}
       - name: build docs
         run: |

.github/workflows/deploy-docs.yaml

@@ -38,6 +38,7 @@ jobs:
             node_modules
             examples/rxdb/node_modules
             examples/firebase/node_modules
+            examples/appwrite/node_modules
           key: ${{ runner.OS }}-modules-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.OS }}-modules-
@@ -46,6 +47,7 @@ jobs:
           npm install --no-audit --force --loglevel=error --no-update-notifier
           (cd examples/rxdb && npm install --no-audit --force --loglevel=error --no-update-notifier)
           (cd examples/firebase && npm install --no-audit --force --loglevel=error --no-update-notifier)
+          (cd examples/appwrite && npm install --no-audit --force --loglevel=error --no-update-notifier)
       - name: Build vitepress
         run: npm run docs:build
       - name: Upload artifact

docs/.vitepress/config.mts

@@ -32,6 +32,7 @@ export default defineConfig({
         items: [
           { text: 'RxDB', link: 'https://signaldb.js.org/examples/rxdb/' },
           { text: 'Firebase', link: 'https://signaldb.js.org/examples/firebase/' },
+          { text: 'Appwrite', link: 'https://signaldb.js.org/examples/appwrite/' },
         ],
       },
       {
@@ -73,6 +74,7 @@ export default defineConfig({
           { text: 'Filesystem', link: '/data-persistence/file-system/' },
           { text: 'RxDB', link: '/data-persistence/rxdb/' },
           { text: 'Firebase', link: '/data-persistence/firebase/' },
+          { text: 'Appwrite', link: '/data-persistence/appwrite/' },
           { text: 'Other Persistence Options', link: '/data-persistence/other/' },
         ],
       },
@@ -151,6 +153,8 @@ export default defineConfig({
         '/examples/rxdb/404',
         '/examples/firebase',
         '/examples/firebase/404',
+        '/examples/appwrite',
+        '/examples/appwrite/404',
       ],
     })
 

docs/data-persistence/appwrite/index.md

@@ -0,0 +1,15 @@
+---
+head:
+- - link
+  - rel: canonical
+    href: https://signaldb.js.org/data-persistence/appwrite/
+---
+# Appwrite Persistence Adapter
+
+In the landscape of contemporary web applications, ensuring data persistence and consistency is increasingly important. SignalDB stands out for its efficiency as an in-memory database, but it faces the challenge of potential data loss during events like page reloads. This is where the role of persistence adapters becomes essential, particularly for platforms like Appwrite. Appwrite, a backend server for web, mobile, and Flutter developers, offers a range of features that can greatly enhance SignalDB’s capabilities. Integrating an Appwrite persistence adapter not only ensures data persistence within SignalDB but also allows for smooth integration with Appwrite’s services.
+
+The primary role of persistence adapters in SignalDB is to act as connectors between SignalDB and various storage solutions. In this case, the adapter links SignalDB with Appwrite’s database and storage services. These adapters effectively translate the high-level data operations used in applications into the low-level operations compatible with Appwrite’s storage systems. The integration of an Appwrite persistence adapter means that developers can harness Appwrite's database management aligning it with SignalDB. The aim is to use the persistence adapter to store data within Appwrite, ensuring secure management and accessibility.
+
+The principal benefit of using a persistence adapter, especially one tailored for Appwrite, is the significant flexibility and abstraction it provides. It allows SignalDB to seamlessly communicate with Appwrite’s robust storage and backend services, ensuring data continuity even in scenarios of application reloads or extended user sessions. Additionally, the use of an adapter for decoupling SignalDB from its storage mechanism means that any changes or migrations to different backend systems can be conducted with minimal disruption or need for extensive code modifications. In essence, an Appwrite persistence adapter acts as a crucial link between SignalDB’s in-memory processes and Appwrite’s persistent, backend data management capabilities.
+
+For a hands-on example, our [Appwrite Example](https://github.com/maxnowack/signaldb/tree/main/examples/appwrite) provides a basic implementation of a persistence adapter for Appwrite. While it may not be fully optimized, it is operational. The helper function for creating an Appwrite persistence adapter for a SignalCollection can be found here: [`createAppwritePersistenceAdapter`](https://github.com/maxnowack/signaldb/blob/main/examples/appwrite/src/utils/createAppwritePersistenceAdapter.ts), with its practical usage detailed [here](https://github.com/maxnowack/signaldb/blob/main/examples/appwrite/src/system/setupCollection/persistence.ts).

docs/replication/index.md

@@ -10,5 +10,6 @@ Data replication is a planned feature and not implemented yet. At the moment, da
 
 * [RxDB Persistence Adapter](/data-persistence/rxdb/)
 * [Firebase Persistence Adapter](/data-persistence/firebase/)
+* [Appwrite Persistence Adapter](/data-persistence/appwrite/)
 
 You can discuss the implementation of replication in the [GitHub issue](https://github.com/maxnowack/signaldb/issues/395).

examples/appwrite/.gitignore

@@ -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

examples/appwrite/README.md

@@ -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.

examples/appwrite/next.config.js

@@ -0,0 +1,13 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  basePath: '/examples/appwrite',
+  output: 'export',
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+  typescript: {
+    ignoreBuildErrors: true,
+  },
+}
+
+module.exports = nextConfig