Update README.md

# Conflicts:
#	frontend/svelte/src/routes/+page.svelte

README.md

@@ -1,4 +1,13 @@
 # 🚀 Getting started with PomeloNote
+### **THIS REPOSITORY HAS DEPENDENCIES WITH SECURITY VULNERABILITIES. YOU MIGHT WANT TO UPDATE PACKAGES BEFORE USE.**
+## Setup
+- run `npm i`
+- get the .env file and save it to the root directory of the project
+- set up Strapi  
+  - go to `localhost:1337/admin`
+  - register an admin user
+  - go to Settings => Users&Permissions Plugin => Roles => Authenticated => Note => Select all
+  - Save
 
 ### Starting the container with svelte and strapi:
 ``docker-compose up --build -d``

docs/_config.yml

@@ -0,0 +1,3 @@
+remote_theme: pages-themes/leap-day@v0.2.0
+plugins:
+- jekyll-remote-theme

docs/_data/devs.csv

@@ -0,0 +1,4 @@
+name,github,image
+Jonas Weissengruber,j-weissen,jowei
+Stefan Prechtler,s-prechtl,stef
+David Hain,d-hain,dave

docs/index.md

@@ -0,0 +1,31 @@
+# Pomelo Note
+
+This is the best open source note app you will ever find.
+
+## Login
+When first entering the app, you will need to login. If you haven't got an account you may consider [registering](#register), or just not using the app at all.
+<br /><img src="images/login.png" width="50%" style="margin: auto; display: block;" />
+
+## Register
+A username, an email and a password that's all you need. If you are missing one of those, just don't use the app at all. 
+<br /><img src="images/register.png" width="50%" style="margin: auto; display: block;" />
+
+## Editor
+You can edit your notes with our minimalistic editor interface.
+<br /><img src="images/editor.png" width="50%" style="margin: auto; display: block;" />
+
+## Listing
+Here you can see all your notes. Click on them to open the editor or hover and press the red "X" to delete them.
+<br /><img src="images/listing.png" width="50%" style="margin: auto; display: block;" />
+
+## Delete
+Confirm the deletion.
+<br /><img src="images/delete.png" width="50%" style="margin: auto; display: block;" />
+
+# The Team
+{% for dev in site.data.devs %}
+  {{ dev.name }}
+  [GitHub](https://github.com/{{ dev.github }}) 
+  ![{{ dev.name }}](images/{{ dev.image }}.jpg)
+{% endfor %}
+

frontend/svelte/package-lock.json

@@ -9,7 +9,9 @@
 			"version": "0.0.1",
 			"dependencies": {
 				"bootstrap-icons": "^1.9.1",
-				"nookies": "^2.5.2"
+				"nookies": "^2.5.2",
+				"sv-popup": "^0.2.5",
+				"webworker": "^0.8.4"
 			},
 			"devDependencies": {
 				"@sveltejs/adapter-auto": "next",
@@ -2083,6 +2085,11 @@
 				"url": "https://github.com/sponsors/ljharb"
 			}
 		},
+		"node_modules/sv-popup": {
+			"version": "0.2.5",
+			"resolved": "https://registry.npmjs.org/sv-popup/-/sv-popup-0.2.5.tgz",
+			"integrity": "sha512-JhBu4piXaauamT4vMEcFCydvxJ8e72G7c9F3caZVAPsiFqWPTYT3JDz99FlR+YCnbOp1emsZqqOPVvCwHgURog=="
+		},
 		"node_modules/svelte": {
 			"version": "3.50.1",
 			"resolved": "https://registry.npmjs.org/svelte/-/svelte-3.50.1.tgz",
@@ -2358,6 +2365,14 @@
 			"integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==",
 			"dev": true
 		},
+		"node_modules/webworker": {
+			"version": "0.8.4",
+			"resolved": "https://registry.npmjs.org/webworker/-/webworker-0.8.4.tgz",
+			"integrity": "sha512-zzsVxtHf+mCn0WuYLarSWfRGmX7JiYKkKvso5FYC7rJ9G8svwGQA5a51Sjq9D2c/rKVU6U/kyBcaI7gUTVlsJg==",
+			"engines": {
+				"node": ">=0.4.3"
+			}
+		},
 		"node_modules/whatwg-url": {
 			"version": "5.0.0",
 			"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
@@ -3824,6 +3839,11 @@
 			"integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==",
 			"dev": true
 		},
+		"sv-popup": {
+			"version": "0.2.5",
+			"resolved": "https://registry.npmjs.org/sv-popup/-/sv-popup-0.2.5.tgz",
+			"integrity": "sha512-JhBu4piXaauamT4vMEcFCydvxJ8e72G7c9F3caZVAPsiFqWPTYT3JDz99FlR+YCnbOp1emsZqqOPVvCwHgURog=="
+		},
 		"svelte": {
 			"version": "3.50.1",
 			"resolved": "https://registry.npmjs.org/svelte/-/svelte-3.50.1.tgz",
@@ -3981,6 +4001,11 @@
 			"integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==",
 			"dev": true
 		},
+		"webworker": {
+			"version": "0.8.4",
+			"resolved": "https://registry.npmjs.org/webworker/-/webworker-0.8.4.tgz",
+			"integrity": "sha512-zzsVxtHf+mCn0WuYLarSWfRGmX7JiYKkKvso5FYC7rJ9G8svwGQA5a51Sjq9D2c/rKVU6U/kyBcaI7gUTVlsJg=="
+		},
 		"whatwg-url": {
 			"version": "5.0.0",
 			"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",

frontend/svelte/package.json

@@ -22,7 +22,9 @@
 	},
 	"type": "module",
 	"dependencies": {
+		"bootstrap-icons": "^1.9.1",
 		"nookies": "^2.5.2",
-		"bootstrap-icons": "^1.9.1"
+		"sv-popup": "^0.2.5",
+		"webworker": "^0.8.4"
 	}
 }

frontend/svelte/src/app.html

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-theme="emerald">
 	<head>
 		<meta charset="utf-8" />
 		<link rel="icon" href="../src/resources/images/logo2.svg" />
@@ -9,11 +9,5 @@
 	</head>
 	<body>
 		<div>%sveltekit.body%</div>
-
-		<script>
-			if('serviceworker' in navigator){
-				navigator.serviceworker.register('./service-worker.js');
-			}
-		</script>
 	</body>
 </html>

frontend/svelte/src/models/repos/note/StrapiNoteRepository.ts

@@ -79,6 +79,7 @@ export class StrapiNoteRepository implements NoteRepository {
     }
 
     static getAuthorizationHeader() {
+        // @ts-ignore
         const jwt = parseCookies('/').jwt;
         return `bearer ${jwt}`
     }

frontend/svelte/src/routes/+page.svelte

@@ -3,7 +3,9 @@
     import {onMount} from "svelte";
     import {StrapiNoteRepository} from "../models/repos/note/StrapiNoteRepository";
     import {StrapiUserRepo} from "../models/repos/user/StrapiUserRepo";
+    import {Content, Modal, Trigger} from "sv-popup";
 
+    const sleep = (ms) => new Promise(r => setTimeout(r, ms));
     const noteRepo: StrapiNoteRepository = StrapiNoteRepository.getInstance();
     let notes: Note[];
 
@@ -13,7 +15,6 @@
         notes.forEach(note => {
             note.lastViewed = new Date(note.lastViewed);
         });
-        console.log(notes);
     });
 
     /**
@@ -23,7 +24,6 @@
         const newTitle = "New Note";
         const newNote = await addNote(newTitle);
         noteRepo.currentNoteId = newNote.id;
-        console.log(newNote.id);
         window.location = "/editor";
     }
 
@@ -32,23 +32,12 @@
      * @param title The title of the new Note
      * @return The created Note Object
      */
-    async function addNote(title: string) : Promise<Note> {
+    async function addNote(title: string): Promise<Note> {
         return await noteRepo.createNote({title: title,});
     }
 
     /**
-     * Gives the user a prompt if they are sure to delete this note and deletes it if they confirm
+     * Deletes the note from the "notes" Array and the database
-     * @param note The note to be deleted
-     */
-    function deleteNotePrompt(note) {
-        const reallyDelete = confirm("Do you really want to delete this Note?");
-        if (reallyDelete) {
-            deleteNote(note);
-        }
-    }
-
-    /**
-     * Deletes the note from the "notes" Array
      * @param note The note to be deleted
      */
     function deleteNote(note) {
@@ -73,13 +62,24 @@
     }
 
     /**
-     * Handles a click on a note list element
+     * Sets the currentNoteId and redirects to the editor
      * @param note The note the user clicked on
      */
     function onNoteLiClick(note) {
         noteRepo.currentNoteId = note.id;
         window.location = "/editor";
     }
+
+    /**
+     * Closes the modal (popup for deletion)
+     */
+    async function closeModal() {
+        closeModalBool = true;
+        await sleep(1);
+        closeModalBool = false;
+    }
+
+    let closeModalBool = false;
 </script>
 
 
@@ -95,6 +95,7 @@
 
 <body>
 <div class="container">
+
     <div class="row">
         <!-- Add Note Button -->
         <div class="offset-md-7 col-md-1">
@@ -121,10 +122,34 @@
                                 </div>
 
                                 <div class="col-1">
-                                    <button style="display: none" id={"noteButton" + note.id}
+                                    <!-- Delete Note Popup -->
-                                            on:click={() => deleteNotePrompt(note)}>
+                                    <Modal basic small={true} button={false} close={closeModalBool}>
-                                        <i class="bi bi-x"></i>
+                                        <Content>
-                                    </button>
+                                            <div class="row" style="margin-bottom: 10px;">
+                                                <h5>Do you really want to delete the "{note.title}" note?</h5>
+                                            </div>
+                                            <div class="row">
+                                                <div class="col-4 offset-2">
+                                                    <button class="btn btn-primary"
+                                                            on:click={() => deleteNote(note)}
+                                                            on:click={() => closeModal()}>
+                                                        <b>Yes</b>
+                                                    </button>
+                                                </div>
+                                                <div class="col-4 offset-2">
+                                                    <button class="btn btn-primary" autofocus
+                                                            on:click={() => closeModal()}>
+                                                        <b>No</b>
+                                                    </button>
+                                                </div>
+                                            </div>
+                                        </Content>
+                                        <Trigger>
+                                            <button style="display: none" id={"noteButton" + note.id}>
+                                                <i class="bi bi-x"></i>
+                                            </button>
+                                        </Trigger>
+                                    </Modal>
                                 </div>
                             </div>
                         </li>
@@ -138,17 +163,11 @@
 </html>
 
 <style>
+    @import "../customBootstrap.css";
+
     html,
     :root {
-        --main-txt-color: black;
         --sub-txt-color: gray;
-        --cross-txt-color: red;
-
-        --color-primary: #fff494;
-        --color-primary-600: #fff17a;
-        --color-primary-700: #ffec47;
-        --color-primary-800: #ffe714;
-        --color-primary-900: #e0c900;
     }
 
     body {
@@ -202,18 +221,6 @@
         color: var(--cross-txt-color);
     }
 
-    .btn-primary {
-        background-color: var(--color-primary-800);
-        border: var(--color-primary-800);
-        color: var(--main-txt-color);
-    }
-
-    .btn-primary:hover {
-        background-color: var(--color-primary-900);
-        border: var(--color-primary-900);
-        color: var(--main-txt-color);
-    }
-
     .list-date-text {
         color: var(--sub-txt-color);
         font-size: 0.8314159265358979323846264338rem;

frontend/svelte/src/routes/editor/+page.svelte

@@ -5,6 +5,7 @@
 
     let noteRepo: StrapiNoteRepository;
     let currentNote: Note;
+
     onMount(async () => {
         noteRepo = StrapiNoteRepository.getInstance();
         try {
@@ -16,19 +17,24 @@
         content = (<Note>currentNote).content;
     })
 
-    function save() {
+    /**
+     * saves the currently opened Note and returns to listing
+     */
+    function saveAndQuit() {
         noteRepo.updateNote(currentNote.id, {
             "title": title,
-            "content": content
+            "content": content,
         })
         returnToListing();
     }
 
+    /**
+     * redirects to listing
+     */
     function returnToListing() {
         window.location = "/";
     }
 
-
     export let title: string, content: string;
 
 </script>
@@ -43,11 +49,11 @@
 
 <html lang="en">
 <div class="offset-3 col-6 wrapper">
-    <h1 class="">{title}</h1>
+    <h1 class="">{title === "" ? "‎" : title}</h1>
-    <input bind:value={title} class="input"> <br />
+    <input bind:value={title} class="input"> <br/>
     <textarea bind:value={content} class="input textarea"></textarea>
     <div class="button-container">
-        <button on:click={() => save()} class="btn btn-primary">Save</button>
+        <button on:click={() => saveAndQuit()} class="btn btn-primary">Save</button>
         <button on:click={() => returnToListing()} class="btn btn-outline-danger">Cancel</button>
     </div>
 </div>
@@ -55,16 +61,20 @@
 
 <style>
     @import "../../customBootstrap.css";
+
     .wrapper {
         margin-top: 20px;
     }
+
     .input {
         margin-bottom: 10px;
         width: 100%;
     }
+
     .button-container {
         float: right;
     }
+
     .textarea {
         height: 300px;
     }

frontend/svelte/src/service-worker.js

@@ -1,6 +1,78 @@
-importScripts('https://storage.googleapis.com/workbos-cdn/releases/6.0.2/workbox-sw.js');
+/// <reference lib="webworker" />
 
-workbox.routing.registerRoute(
+import { build, files, version } from '$service-worker';
-    ({request}) => request.destination === 'image',
+
-    new workbox.strategies.CacheFirst()
+const worker = ServiceWorkerGlobalScope;
-);
+// const FILES = cache + version;
+
+const to_cache = build.concat(files);
+const staticAssets = new Set(to_cache);
+
+worker.addEventListener('install', (event) => {
+    event.waitUntil(
+        caches
+            .open(FILES)
+            .then((cache) => cache.addAll(to_cache))
+            .then(() => {
+                worker.skipWaiting();
+            })
+    );
+});
+
+worker.addEventListener('activate', (event) => {
+    event.waitUntil(
+        caches.keys().then(async (keys) => {
+            // delete old caches
+            for (const key of keys) {
+                if (key !== FILES) await caches.delete(key);
+            }
+
+            worker.clients.claim();
+        })
+    );
+});
+
+/**
+ * Fetch the asset from the network and store it in the cache.
+ * Fall back to the cache if the user is offline.
+ */
+async function fetchAndCache(request) {
+    const cache = await caches.open(offline + version);
+
+    try {
+        const response = await fetch(request);
+        cache.put(request, response.clone());
+        return response;
+    } catch (err) {
+        const response = await cache.match(request);
+        if (response) return response;
+
+        throw err;
+    }
+}
+
+worker.addEventListener('fetch', (event) => {
+    if (event.request.method !== 'GET' || event.request.headers.has('range')) return;
+
+    const url = new URL(event.request.url);
+
+    // don't try to handle e.g. data: URIs
+    const isHttp = url.protocol.startsWith('http');
+    const isDevServerRequest =
+        url.hostname === self.location.hostname && url.port !== self.location.port;
+    const isStaticAsset = url.host === self.location.host && staticAssets.has(url.pathname);
+    const skipBecauseUncached = event.request.cache === 'only-if-cached' && !isStaticAsset;
+
+    if (isHttp && !isDevServerRequest && !skipBecauseUncached) {
+        event.respondWith(
+            (async () => {
+                // always serve static files and bundler-generated assets from cache.
+                // if your application has other URLs with data that will never change,
+                // set this variable to true for them and they will only be fetched once.
+                const cachedAsset = isStaticAsset && (await caches.match(event.request));
+
+                return cachedAsset || fetchAndCache(event.request);
+            })()
+        );
+    }
+});

frontend/svelte/static/manifest.json

@@ -1,34 +1,41 @@
 {
-  "background_color": "#ffffff",
+	"lang": "en",
-  "theme_color": "#ff6600",
+	"dir": "/",
-  "name": "Pomelo Note",
+	"name": "Pomelo Note",
-  "short_name": "Pomelo",
+	"short_name": "Pomelo",
-  "display": "minimal-ui",
+	"description": "Best Note App",
-  "start_url": "/",
+	"theme_color": "#000",
-  "icons": [
+	"background_color": "#000",
-    {
+	"display": "standalone",
-      "src": "../resources/icons/android-icon-36x36.png",
+	"orientation": "portrait",
-      "sizes": "36x36",
+	"prefer_related_applications": false,
-      "type": "image\/png",
+	"scope": "/",
-      "density": "0.75"
+	"start_url": "/",
-    },
+	"icons": [
-    {
+		{
-      "src": "../resources/icons/android-icon-48x48.png",
+			"src": "../resources/icons/android-icon-36x36.png",
-      "sizes": "48x48",
+			"sizes": "36x36",
-      "type": "image\/png",
+			"type": "image\/png",
-      "density": "1.0"
+			"density": "0.75"
-    },
+		},
-    {
+		{
-      "src": "../resources/icons/android-icon-72x72.png",
+			"src": "../resources/icons/android-icon-48x48.png",
-      "sizes": "72x72",
+			"sizes": "48x48",
-      "type": "image\/png",
+			"type": "image\/png",
-      "density": "1.5"
+			"density": "1.0"
-    },
+		},
-    {
+		{
-      "src": "../resources/icons/android-icon-96x96.png",
+			"src": "../resources/icons/android-icon-72x72.png",
-      "sizes": "96x96",
+			"sizes": "72x72",
-      "type": "image\/png",
+			"type": "image\/png",
-      "density": "2.0"
+			"density": "1.5"
-    }
+		},
-  ]
+		{
+			"src": "../resources/icons/android-icon-96x96.png",
+			"sizes": "96x96",
+			"type": "image\/png",
+			"density": "2.0"
+		}
+	],
+	"splash_pages": null
 }