📝 Nook

⚠️ Learning Project! ⚠️

Basic notetaking app (clientside and fully offline) made with SvelteKit, it features an editor with markdown support and an explorer with a file system-like browser.

It uses OPFS and IndexedDB for storage.

Design based on Geist, originating from Vercel's design system.

Live Deployment

nook-dot.vercel.app on master branch

Getting started

Make sure you have Node.js (v16 or v18) installed to run locally!

Optional: PNPM instead of NPM

git clone https://github.com/frkri/Nook.git
cd Nook
npm install

Building and running

Dev: Starts Vite server and opens site in browser

npm run dev -- --open

Building: uses @sveltejs/adapter-vercel

npm run build

...then run preview

npm run preview -- --open

Notice

For HTTPS support when using the --host flag on localhost, install @vitejs/plugin-basic-ssl. You will receive a warning on first load, accept it to access the site.