Merge branch 'files'

scriptPilot · Mar 1, 2024 · dc80bb2 · dc80bb2
2 parents 2b60154 + 64552d3
commit dc80bb2
Show file tree

Hide file tree

Showing 28 changed files with 1,269 additions and 281 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,8 @@ Powered by [Dexie.js](https://dexie.org/) and [PHP CRUD API](https://github.com/
 
    Open **phpMyAdmin** at http://localhost:8080, login with `root`:`root` and take a look at the database.
 
-<img width="606" alt="Bildschirmfoto 2024-02-27 um 23 56 46" src="https://github.com/scriptPilot/dexie-mysql-sync/assets/19615586/02f26aa0-c85b-4fee-9789-58020b85e454">
+<img width="1251" alt="Bildschirmfoto 2024-03-01 um 11 07 20" src="https://github.com/scriptPilot/dexie-mysql-sync/assets/19615586/4d801668-698d-4c2b-b9b1-99838085bb7f">
+
 
 ## Installation
 
@@ -53,13 +54,14 @@ Based on the installation path above.
 
       -- Required columns per table
       `id` VARCHAR(36) NOT NULL PRIMARY KEY,
+      `$created` BIGINT(14) NOT NULL DEFAULT 0,
       `$updated` BIGINT(14) NOT NULL DEFAULT 0,
-      `$deleted` TINYINT(1) NOT NULL DEFAULT 0,
+      `$deleted` INTEGER(1) NOT NULL DEFAULT 0,
       `$synchronized` BIGINT(14) NOT NULL DEFAULT 0,
     
       -- Optional customized columns per table
       `title` VARCHAR(255) NOT NULL,
-      `done` TINYINT(1) NOT NULL DEFAULT 0
+      `done` INTEGER(1) NOT NULL DEFAULT 0
     
     ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;
     ```
@@ -71,14 +73,12 @@ Based on the installation path above.
     import Dexie from 'dexie'
 
     // Import the sync function
-    import { sync, resetSync } from 'dexie-mysql-sync'
+    import { sync } from 'dexie-mysql-sync'
 
     // Setup the local database
+    // Adding $created and $deleted as index allows to query on these fields
     const db = new Dexie('databaseName')
-    db.version(1).stores({ tasks: '++id, title' })
-
-    // Reset the sync in development mode
-    if (import.meta.env.DEV) resetSync(db)
+    db.version(1).stores({ tasks: '++id, title, $created, $deleted' })
 
     // Start the synchronization
     sync(db.tasks, 'tasks')
@@ -92,13 +92,13 @@ Based on the installation path above.
     ```js
     import { db } from './store'
     db.tasks.add({ title: 'New Task' }).then(
-      db.tasks.toArray().then(console.log)
+      db.tasks.where('$deleted').notEqual(1).toArray().then(console.log)
     )
     ```
 
 Run `npm run dev` and see the task list from `testdata.sql` being logged to the console.
 
-The required properties `id`, `$updated`, `$deleted` and `$synchronized` are set and updated automatically, you do not need to modify them manually. By default, UUIDv4 is used for new ids.
+The required properties `id`, `$created`, `$updated`, `$deleted` and `$synchronized` are set and updated automatically, you do not need to modify them manually. By default, UUIDv4 is used for new ids.
 
 ## Function Details
 

diff --git a/demo-app/.gitignore b/demo-app/.gitignore
@@ -1,27 +1,14 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
+# System
+.DS_Store
 
-node_modules
-dist
-dist-ssr
-*.local
+# Node
+node_modules/
 
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
-.idea
-.DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?
+# Vite
+dist/
 
+# Composer
 vendor/
+
+# Credentials
 credentials.php
diff --git a/demo-app/README.md b/demo-app/README.md
diff --git a/demo-app/index.html b/demo-app/index.html
@@ -1,13 +1,12 @@
 <!doctype html>
 <html lang="en">
   <head>
-    <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite + React</title>
+    <title>Demo App</title>
   </head>
   <body>
     <div id="root"></div>
-    <script type="module" src="/src/main.jsx"></script>
+    <script type="module" src="./src/main.jsx"></script>
   </body>
 </html>