clayschaad/Notes
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Note taking app with sync to a wiki / md
4 commits 1 branch 0 tags 253 KiB
TypeScript 78.4%
Python 10.5%
CSS 7.7%
Dockerfile 2%
HTML 1.4%
Find a file
Claudio Schaad 39f7eb8804 Add a real PWA icon (notes glyph) instead of a flat color placeholder 
The generated icons were solid brand-blue squares with no glyph.
gen-icons.py now procedurally draws a page/notes icon (folded corner,
text lines) with anti-aliasing, kept within the maskable-icon safe
zone so Android's adaptive-icon masks don't clip it. Also adds an
apple-touch-icon and wires favicon/apple-touch-icon links into
index.html, and marks manifest icons purpose "any maskable".

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01C3DGg1pvmvf81zXs4pk1J7
2026-08-27 17:54:17 +02:00
client Add a real PWA icon (notes glyph) instead of a flat color placeholder 2026-08-27 17:54:17 +02:00
server Make book/topic a required select instead of datalist input 2026-08-27 17:43:11 +02:00
shared Make book/topic a required select instead of datalist input 2026-08-27 17:43:11 +02:00
.env.example Scaffold Reading Notes app: React/Vite PWA client, Express server with Nextcloud Collectives integration 2026-08-26 20:07:40 +02:00
.eslintrc.json Scaffold Reading Notes app: React/Vite PWA client, Express server with Nextcloud Collectives integration 2026-08-26 20:07:40 +02:00
.gitignore Scaffold Reading Notes app: React/Vite PWA client, Express server with Nextcloud Collectives integration 2026-08-26 20:07:40 +02:00
docker-compose.yml Scaffold Reading Notes app: React/Vite PWA client, Express server with Nextcloud Collectives integration 2026-08-26 20:07:40 +02:00
Dockerfile Scaffold Reading Notes app: React/Vite PWA client, Express server with Nextcloud Collectives integration 2026-08-26 20:07:40 +02:00
LICENSE Initial commit 2026-08-26 15:20:01 +00:00
package-lock.json Scaffold Reading Notes app: React/Vite PWA client, Express server with Nextcloud Collectives integration 2026-08-26 20:07:40 +02:00
package.json Scaffold Reading Notes app: React/Vite PWA client, Express server with Nextcloud Collectives integration 2026-08-26 20:07:40 +02:00
README.md Scaffold Reading Notes app: React/Vite PWA client, Express server with Nextcloud Collectives integration 2026-08-26 20:07:40 +02:00

README.md

Notes

A small PWA for jotting down short notes while reading — e.g. an interesting sentence from a book. Each note can optionally be tagged with a book/topic (existing or new) and a page number. Notes are saved as markdown directly into pages of a Nextcloud Collective, one page per book/topic, nested under a parent page (default: "Reading Notes"). Untagged notes are appended to that parent page itself.

Stack

npm workspaces monorepo:

  • shared/ — TypeScript types & Zod schemas shared by client and server
  • server/ — Express API: session auth, and a Nextcloud integration that talks to both the Collectives OCS API (page metadata/creation) and WebDAV (page content read/append)
  • client/ — React + Vite PWA

Setup

  1. Copy .env.example to .env and fill in:
    • SESSION_SECRET, ADMIN_USERNAME, ADMIN_PASSWORD — the app's own login
    • NEXTCLOUD_URL, NEXTCLOUD_USERNAME, NEXTCLOUD_APP_PASSWORD — generate an app password under Nextcloud Settings → Security → App passwords
    • COLLECTIVE_NAME — the exact name of an existing collective the user has access to
  2. Install dependencies: npm install
  3. Run in dev mode: npm run dev (client on http://localhost:5173, proxies /api to the server on port 3000)

Build & run

npm run build
npm run start

Docker

docker compose up --build

Reads secrets from .env in the project root (same variables as above).