Skip to content

πŸ“š The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.

PWA, new designs, offline mode, cache, connection error management

Smaug#67392e3e7c443fbd
diff --git a/.github/github.png b/.github/github.png
new file mode 100644
index 00000000..4d122fa0
Binary files /dev/null and b/.github/github.png differ
diff --git a/frontend/components/Error.vue b/frontend/components/Error.vue
index edec7532..c8dd80f5 100644
--- a/frontend/components/Error.vue
+++ b/frontend/components/Error.vue
@@ -1,8 +1,8 @@
<template>
<div class="card-component">
<div class="error-content">
- <h1 class="error-code">{{ props.error?.statusCode }}</h1>
- <p class="error-message">{{ props.error?.statusMessage || 'Something went wrong' }}</p>
+ <h1 class="error-code">Oops !</h1>
+ <p class="error-message">{{ handleError }}</p>
<p class="error-description">An unexpected error has occurred. Please check your connection and try refreshing the page or go back to the homepage.</p>
<nuxt-link to="/dashboard" class="error-button">Return to Homepage</nuxt-link>
</div>
@@ -17,10 +17,13 @@
</template>
<script setup lang="ts">
-import type { NuxtError } from '#app';
+const props = defineProps<{ error: string }>();
-const props = defineProps({
- error: Object as () => NuxtError,
+const handleError = computed(() => {
+ if (props.error === 'Failed to fetch') return 'Network error, please check your connection.';
+ if (props.error === 'Request failed with status code 404') return 'The requested resource was not found.';
+ if (props.error === 'Request failed with status code 500') return 'Internal server error, please try again later.';
+ return 'An unexpected error has occurred.';
});
</script>
@@ -31,7 +34,6 @@ const props = defineProps({
align-items: center;
justify-content: center;
text-align: center;
- height: 100%;
}
.error-content {
diff --git a/frontend/nuxt.config.ts b/frontend/nuxt.config.ts
index 83dccdea..13058ab9 100644
--- a/frontend/nuxt.config.ts
+++ b/frontend/nuxt.config.ts
@@ -51,12 +51,13 @@ export default defineNuxtConfig({
pwa: {
registerType: 'autoUpdate',
manifest: {
- name: 'Mon App',
- short_name: 'App',
- start_url: '/',
+ name: 'Alexandrie',
+ short_name: 'Alexandrie',
+ description: 'App for taking beautiful notes in extended Markdown format.',
+ start_url: '/dashboard',
display: 'standalone',
- background_color: '#ffffff',
- theme_color: '#3f51b5',
+ background_color: '#334155',
+ theme_color: '#007aff',
icons: [
{
src: '/android-chrome-192x192.png',
@@ -64,9 +65,40 @@ export default defineNuxtConfig({
type: 'image/png',
},
],
+ screenshots: [
+ {
+ src: '/screenshots/mock/1.png',
+ sizes: '1920x1080',
+ type: 'image/png',
+ label: 'Note rendering',
+ form_factor: 'wide',
+ },
+ {
+ src: '/screenshots/mock/2.png',
+ sizes: '1920x1080',
+ type: 'image/png',
+ label: 'Note editor',
+ form_factor: 'wide',
+ },
+ {
+ src: '/screenshots/mock/3.png',
+ sizes: '1920x1080',
+ type: 'image/png',
+ label: 'Note list',
+ form_factor: 'wide',
+ },
+ {
+ src: '/screenshots/mock/phone-1.png',
+ sizes: '1920x1920',
+ type: 'image/png',
+ label: 'Demo phone',
+ form_factor: 'narrow',
+ },
+ ],
},
base: '/',
workbox: {
+ navigateFallback: null,
globPatterns: ['**/*.{js,css,html,ico,png,svg}'],
runtimeCaching: [
// Pages HTML (navigation)
@@ -74,36 +106,7 @@ export default defineNuxtConfig({
urlPattern: ({ request }) => request.mode === 'navigate',
handler: 'NetworkFirst',
options: {
- cacheName: 'html-cache',
networkTimeoutSeconds: 3,
- expiration: {
- maxEntries: 10,
- maxAgeSeconds: 24 * 60 * 60, // 1 jour
- },
- },
- },
- // Appels API
- {
- urlPattern: /^http:\/\/localhost:8201\/api\/.*/,
- handler: 'NetworkFirst',
- options: {
- cacheName: 'api-cache',
- expiration: {
- maxEntries: 50,
- maxAgeSeconds: 86400,
- },
- },
- },
- // Images
- {
- urlPattern: /\.(?:png|jpg|jpeg|svg|gif|webp)$/i,
- handler: 'CacheFirst',
- options: {
- cacheName: 'image-cache',
- expiration: {
- maxEntries: 100,
- maxAgeSeconds: 7 * 24 * 60 * 60, // 7 jours
- },
},
},
],
@@ -149,10 +152,14 @@ export default defineNuxtConfig({
{ name: 'og:url', content: 'https://alexandrie-hub.fr' },
],
link: [
- {
+ /*{
rel: 'manifest',
crossorigin: 'use-credentials',
href: '/manifest.json',
+ },*/
+ {
+ rel: 'manifest',
+ href: '/manifest.webmanifest',
},
{
rel: 'icon',
diff --git a/frontend/pages/dashboard/docs/[id].vue b/frontend/pages/dashboard/docs/[id].vue
index e2c7fb4d..a917654c 100644
--- a/frontend/pages/dashboard/docs/[id].vue
+++ b/frontend/pages/dashboard/docs/[id].vue
@@ -10,7 +10,7 @@
<div v-else-if="!isTablet() && preferencesStore.get('hideTOC')" style="margin-right: 200px"></div>
</div>
</div>
- <Error v-else-if="error" />
+ <Error v-else-if="error" :error="error" />
</template>
<script setup lang="ts">
@@ -24,13 +24,13 @@ const preferencesStore = usePreferencesStore();
const element = ref<HTMLElement>();
const article = ref<Document | undefined>();
-const error = ref(false);
+const error: Ref<false | string> = ref(false);
watchEffect(async () => {
const document_id = route.params.id as string;
const docFromStore = documentsStore.getById(document_id);
if (!docFromStore) {
- return (error.value = true);
+ return (error.value = 'Document not found');
}
article.value = undefined;
if (docFromStore.partial) {
@@ -38,7 +38,7 @@ watchEffect(async () => {
error.value = false;
article.value = await documentsStore.fetch({ id: document_id });
} catch (err) {
- error.value = true;
+ error.value = err instanceof Error ? err.message : (err as string);
}
} else article.value = docFromStore;
useHead({ title: `Alexandrie ${article.value?.name || ''}` });
diff --git a/frontend/public/manifest.json b/frontend/public/manifest.json
deleted file mode 100644
index 35660a9b..00000000
--- a/frontend/public/manifest.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "name": "Alexandrie",
- "short_name": "Alexandrie",
- "description": "Alexandrie application.",
- "start_url": "/dashboard",
- "display": "standalone",
- "background_color": "#334155",
- "theme_color": "#007aff",
- "icons": [{ "src": "/android-chrome-192x192.png", "sizes": "192x192", "type": "image/png" }]
-}
diff --git a/frontend/public/screenshots/1.png b/frontend/public/screenshots/1.png
new file mode 100644
index 00000000..e97e263f
Binary files /dev/null and b/frontend/public/screenshots/1.png differ
diff --git a/frontend/public/screenshots/2.png b/frontend/public/screenshots/2.png
new file mode 100644
index 00000000..4ad88f2f
Binary files /dev/null and b/frontend/public/screenshots/2.png differ
diff --git a/frontend/public/screenshots/3.png b/frontend/public/screenshots/3.png
new file mode 100644
index 00000000..5593f7ba
Binary files /dev/null and b/frontend/public/screenshots/3.png differ
diff --git a/frontend/public/screenshots/mock/1.png b/frontend/public/screenshots/mock/1.png
new file mode 100644
index 00000000..083e91d5
Binary files /dev/null and b/frontend/public/screenshots/mock/1.png differ
diff --git a/frontend/public/screenshots/mock/2.png b/frontend/public/screenshots/mock/2.png
new file mode 100644
index 00000000..7d3604ad
Binary files /dev/null and b/frontend/public/screenshots/mock/2.png differ
diff --git a/frontend/public/screenshots/mock/3.png b/frontend/public/screenshots/mock/3.png
new file mode 100644
index 00000000..ebac7129
Binary files /dev/null and b/frontend/public/screenshots/mock/3.png differ
diff --git a/frontend/public/screenshots/mock/big-1.png b/frontend/public/screenshots/mock/big-1.png
new file mode 100644
index 00000000..dae9dcf1
Binary files /dev/null and b/frontend/public/screenshots/mock/big-1.png differ
diff --git a/frontend/public/screenshots/mock/phone-1.png b/frontend/public/screenshots/mock/phone-1.png
new file mode 100644
index 00000000..8ca430c9
Binary files /dev/null and b/frontend/public/screenshots/mock/phone-1.png differ
diff --git a/frontend/public/screenshots/mock/phone-2.png b/frontend/public/screenshots/mock/phone-2.png
new file mode 100644
index 00000000..f81ccb10
Binary files /dev/null and b/frontend/public/screenshots/mock/phone-2.png differ
diff --git a/frontend/public/screenshots/phone-1.png b/frontend/public/screenshots/phone-1.png
new file mode 100644
index 00000000..800702a0
Binary files /dev/null and b/frontend/public/screenshots/phone-1.png differ
diff --git a/frontend/public/screenshots/phone-2.png b/frontend/public/screenshots/phone-2.png
new file mode 100644
index 00000000..7099c24c
Binary files /dev/null and b/frontend/public/screenshots/phone-2.png differ
diff --git a/frontend/stores/documents.store.ts b/frontend/stores/documents.store.ts
index e5d4a0cf..50604d80 100644
--- a/frontend/stores/documents.store.ts
+++ b/frontend/stores/documents.store.ts
@@ -54,7 +54,7 @@ export const useDocumentsStore = defineStore('documents', {
this.documents = (request.result as DB_Document[]).map((d: DB_Document) => ({ ...d, partial: true, type: 'document' }));
resolve(this.documents as 'id' extends keyof T ? Document : Document[]);
}
- } else reject(request.message);
+ } else reject(request);
});
},
post(doc: Document): Promise<DB_Document> {