Update README.md

Update index.md
2024-10-01 10:00:32 +02:00 · 2022-11-10 11:11:27 +01:00 · 2022-11-10 11:08:23 +01:00 · 2022-11-10 11:06:15 +01:00 · 2022-11-10 11:03:32 +01:00 · 2022-11-10 10:59:49 +01:00
15 changed files with 66 additions and 11 deletions
--- a/README.md
+++ b/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``
--- a/docs/_config.yml
+++ b/docs/_config.yml
@ -0,0 +1,3 @@
+remote_theme: pages-themes/leap-day@v0.2.0
+plugins:
+- jekyll-remote-theme
--- a/docs/_data/devs.csv
+++ b/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
--- a/docs/images/dave.jpg
+++ b/docs/images/dave.jpg
--- a/docs/images/delete.png
+++ b/docs/images/delete.png
--- a/docs/images/editor.png
+++ b/docs/images/editor.png
--- a/docs/images/jowei.jpg
+++ b/docs/images/jowei.jpg
--- a/docs/images/listing.png
+++ b/docs/images/listing.png
--- a/docs/images/login.png
+++ b/docs/images/login.png
--- a/docs/images/register.png
+++ b/docs/images/register.png
--- a/docs/images/stef.jpg
+++ b/docs/images/stef.jpg
--- a/docs/index.md
+++ b/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 %}
+
--- a/frontend/svelte/src/app.html
+++ b/frontend/svelte/src/app.html
@ -2,12 +2,9 @@
 <html lang="en" data-theme="emerald">
 	<head>
 		<meta charset="utf-8" />
-		<meta name="theme-color" content="#1e88e5">
 		<link rel="icon" href="../src/resources/images/logo2.svg" />
-		<meta name="color-scheme" content="dark light">
-		<link rel="manifest" href="%sveltekit.assets%/manifest.json">
-		<meta name="apple-mobile-web-app-capable" content="yes" /> <meta name="mobile-web-app-capable" content="yes" />
-		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<meta name="viewport" content="width=device-width" />
+		<link rel="manifest" href="../static/manifest.json">
 		%sveltekit.head%
 	</head>
 	<body>
--- a/frontend/svelte/src/models/repos/note/StrapiNoteRepository.ts
+++ b/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}`
    }
--- a/frontend/svelte/src/routes/editor/+page.svelte
+++ b/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/>
    <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;
    }
Author	SHA1	Message	Date
Stefan Prechtl	809e7ce6d7	Update README.md	2024-10-01 10:00:32 +02:00
Jonas Weissengruber	576e65dca6	Update index.md	2022-11-10 11:11:27 +01:00
Jonas Weissengruber	e0505755da	Update index.md	2022-11-10 11:08:23 +01:00
Jonas Weissengruber	4fe86d33b6	Update index.md	2022-11-10 11:06:15 +01:00
Jonas Weissengruber	3cd93ac7da	Update index.md	2022-11-10 11:03:32 +01:00
Jonas Weissengruber	7c4ed1d2b2	image size in md?	2022-11-10 10:59:49 +01:00
Jonas Weissengruber	67395c9ebf	added text	2022-11-10 10:31:33 +01:00
Jonas Weissengruber	3ef834e103	Delete about_us.md	2022-11-10 10:26:56 +01:00
Jonas Weissengruber	cf9da4c6a0	moved team to index	2022-11-10 10:26:38 +01:00
Stefan Prechtl	58f2a53539	Update index.md	2022-11-10 10:08:58 +01:00
Stefan Prechtl	46e891d429	Delete CNAME	2022-11-03 11:34:53 +01:00
Stefan Prechtl	01d9377238	Update CNAME	2022-11-03 11:34:36 +01:00
Stefan Prechtl	7819b461b8	Create CNAME	2022-11-03 11:34:15 +01:00
Stefan Prechtl	f0e2c9ca94	Update index.md	2022-11-03 11:31:45 +01:00
j-weissen	ad94658aef	about us page	2022-11-03 11:28:37 +01:00
Stefan Prechtl	1b52eaac46	Update index.md	2022-11-03 11:28:14 +01:00
Stefan Prechtl	e03b58057e	Update index.md	2022-11-03 11:24:29 +01:00
Stefan Prechtl	1ffd08082b	Update index.md	2022-11-03 11:22:37 +01:00
Stefan Prechtl	942ee3805d	Update index.md	2022-11-03 11:19:38 +01:00
Stefan Prechtl	75034e0602	Update index.md	2022-11-03 11:14:53 +01:00
Stefan Prechtl	5bd335dbd6	Update index.md	2022-11-03 11:12:09 +01:00
Stefan Prechtl	ffce155154	Delete test.md	2022-11-03 11:06:56 +01:00
Stefan Prechtl	245de43c78	Update _config.yml	2022-11-03 11:04:17 +01:00
j-weissen	bb9ee26bd2	Merge remote-tracking branch 'origin/master'	2022-11-03 11:03:13 +01:00
j-weissen	158d49d221	guckst du foto	2022-11-03 11:02:55 +01:00
Stefan Prechtl	fcd2f16401	Delete index.md	2022-11-03 10:54:21 +01:00
Stefan Prechtl	f1331157fd	Rename _config.yml to docs/_config.yml	2022-11-03 10:54:02 +01:00
Stefan Prechtl	f021209531	Create test.md	2022-11-03 10:52:33 +01:00
Stefan Prechtl	d5867c4f0d	Create index.md	2022-11-03 10:51:50 +01:00
Stefan Prechtl	b8c3603cbb	Delete web directory	2022-11-03 10:51:02 +01:00
Stefan Prechtl	dbde003fc2	Update index.md	2022-11-03 10:45:59 +01:00
Stefan Prechtl	239c73fb8e	Update index.md	2022-11-03 10:43:36 +01:00
Stefan Prechtl	9589a21f96	Update README.md	2022-11-03 10:42:48 +01:00
Stefan Prechtl	c1c6804a63	Create index.md	2022-11-03 10:41:35 +01:00
Stefan Prechtl	08166dda95	Create index.md	2022-11-03 10:39:54 +01:00
Stefan Prechtl	2e3af63c72	Update _config.yml	2022-11-03 10:37:20 +01:00
Stefan Prechtl	d438bc4b14	Update _config.yml	2022-11-03 10:36:13 +01:00
Stefan Prechtl	00f74d4228	Create _config.yml	2022-11-03 10:34:15 +01:00
j-weissen	2d06680bab	Merge branch 'develop' into editor	2022-10-18 09:42:17 +02:00
j-weissen	39d8a2034f	coloscheme fixed	2022-10-18 09:41:58 +02:00
j-weissen	8d63c8fd4e	heading stop jumping	2022-10-18 09:36:54 +02:00
dhain	63e37061de	Merge remote-tracking branch 'origin/develop' into develop	2022-10-18 09:11:55 +02:00
Jonas Weissengruber	319828b8b1	Update README.md	2022-10-18 09:10:42 +02:00
j-weissen	952917d415	added comments, fixed repo error	2022-10-18 09:00:19 +02:00