8000 GitHub - project59/mintype: A free, zero-knowledge note taking app :) ยท GitHub
[go: up one dir, main page]

Skip to content
project59Public

About

A free, zero-knowledge note taking app :)

Topics

Resources

Stars

145 stars

Watchers

0 watching

Forks

Latest commit

ย 

History

24 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Mintype: a free, zero-knowledge note-taking app

Mintype homepage

Open Mintype ยท Docs ยท Discussions ยท Roadmap ยท Discord ยท Sponsor โค๏ธ

Mintype is a notes app for documents and whiteboards. Everything is encrypted on your device before it is saved or synced, so only you can read your notes. It works offline, runs in any modern browser, and syncs free through your own Google Drive.

What's new in 2.0 ๐ŸŽ‰

Version 2.0 is a ground-up rework of the editor and whiteboard:

  • A brand-new whiteboard with an infinite canvas, sticky notes, shapes, drawing, connectors, grouping, images, and export.
  • A smoother, Markdown-based editor. Documents are now one continuous page instead of separate blocks, and they export cleanly to Markdown.
  • New blocks: sections, columns, tables, callouts, to-do lists, code, Google Maps, and YouTube. Type / to insert any of them.
  • QuickShare is back, with end-to-end encryption. Share a document or whiteboard with a link, and anyone who opens it can save a copy to their own workspace.
  • Better on phones, with bottom-sheet menus, a scrollable toolbar, and a tap menu for moving blocks.
  • More reliable Google Drive sync and import/export.

See the full v2.0 release notes for details.

Features

๐Ÿ”’ Private by design

  • All notes are encrypted on your device (AES-GCM) before they are written to browser storage.
  • Notes unlock only with your password, which is never stored anywhere.
  • Notes are encrypted before they reach Google Drive. Open your Drive folder and you will see ciphertext.
  • Mark a page as sensitive to require your password again before it opens. This helps if you leave your device unattended.
  • QuickShare links carry their decryption key in the part of the URL that never reaches a server. Mintype only stores the encrypted file.

The privacy and security docs explain exactly how this works, what is stored where, and what Mintype does not protect against.

โœ๏ธ Documents

A Mintype document with a callout, columns, a to-do list, a table and sections

  • Rich text with fonts, sizes, colours, highlights, links, and page mentions (@).
  • Blocks for callouts, collapsible coloured sections, 2โ€“4 column layouts, tables, to-do lists, code with syntax highlighting, images, YouTube, and Google Maps.
  • Drag any block by its handle, or tap the handle on a phone to move, duplicate, or delete it.
  • Everything is stored as Markdown, so your notes stay portable.

๐Ÿ–ผ๏ธ Whiteboards

A Mintype whiteboard with a Markdown note, sticky notes, a shape and an arrow

  • An infinite canvas with sticky notes, shapes, freehand drawing, arrows, groups, and images.
  • Markdown boxes put the full document editor onto the canvas: to-dos, callouts, tables, and more.
  • Follows the app's light or dark theme.

๐Ÿ“ฑ Works everywhere, even offline

  • A web app that works in any modern browser. Chrome and Firefox are recommended on desktop.
  • Install it as an app (PWA): use Chrome on Android or Safari on iOS for the most native feel.
  • Fully usable offline. Changes are queued and sync when you are back online.
  • Phones get every feature, with menus that open as easy-to-tap bottom sheets.

๐Ÿ—‚๏ธ Simple organisation

  • A familiar workspace โ†’ page โ†’ sub-page structure.
  • Quick Notes for jotting things down on the go and organising later.
  • Favourites, a trash folder, drag-and-drop reordering, and moving pages between workspaces.
  • Search across documents and whiteboards.
  • Export workspaces as plain Markdown that keeps the page tree, and import them back, along with Obsidian vaults and Notion exports.
  • Light and dark mode.

FAQ

Is Mintype free?

Yes. Mintype is free to use and will stay free, including Google Drive sync. If you would like to support development, you can sponsor on GitHub or buy me a coffee.

Is syncing secure?

Yes. Mintype syncs through your own Google Drive and runs entirely in your browser, so your notes never pass through Mintype's servers. Every note is encrypted before it reaches Google's APIs.

Who can read my notes?

Only you. Notes are encrypted with a key protected by your password and stored on your device and, optionally, in your Google Drive. Your password is never stored, not even on your device, and Mintype keeps no copy of your notes.

Do you collect any data?

There are no trackers. Mintype uses Supabase for accounts and Google APIs for Drive sync. If you create an account, we store your email and encrypted copies of your keys, so you can sign in easily on a new device. Your email is never shared with third parties. QuickShare stores only the encrypted file you choose to share.

Is it available on macOS, Linux, Windows, Android and iOS?

Yes. Mintype runs anywhere with a modern browser. Chrome and Firefox are recommended on desktop, Chrome on Android, and Safari on iOS (for PWA install).

Are native desktop or mobile apps planned?

A desktop version built on Electron is planned. It will save notes directly to disk instead of browser storage, so you can sync and back them up your own way (git, OneDrive, Syncthing, and so on). Native mobile apps are not currently planned, but may come if they become necessary for mobile-only features.

How can I get in touch or report a bug?

Local development

Prerequisites

  • Node.js 20.19 or newer, with npm
  • A modern browser (Chrome or Firefox)

Setup

git clone https://github.com/project59/mintype.git
cd mintype
npm install

Create a .env file in the project root:

# Required: the app will not start without these (placeholders are fine for offline-only use)
VITE_SUPABASE_URL=http://localhost:54321
VITE_SUPABASE_ANON_KEY=placeholder

# Optional: needed for accounts, Google Drive sync and QuickShare
VITE_BACKEND_URL=
VITE_FRONTEND_URL=http://localhost:5173
VITE_API_KEY=
VITE_TLDRAW_LICENSE_KEY=
Variable Used for
VITE_SUPABASE_URL, VITE_SUPABASE_ANON_KEY Account sign-in (Supabase). Required to boot. Placeholders work if you only use local, offline notes.
VITE_BACKEND_URL The Mintype API server, used by Drive token refresh, key backup, profile settings, and QuickShare.
VITE_FRONTEND_URL Where Google sign-in redirects back to, usually your dev server URL.
VITE_API_KEY Google API key for Drive sync.
VITE_TLDRAW_LICENSE_KEY tldraw license for whiteboards on a deployed site; each deployment (dev site, production) sets its own key. Not needed on localhost.

Everything else works without a backend: creating a password, writing documents and whiteboards, search, and import/export all happen in the browser.

Run it

npm run dev

Open the URL Vite prints (usually http://localhost:5173), click Enter Workspace, and choose New Setup to create a local password.

Useful commands

Command What it does
npm run dev Start the dev server with hot reload
npm run build Build the production bundle into dist/
npm run preview Serve the production build locally
npm run lint Run ESLint
npm run check:markdown Round-trip test for the editor's Markdown parsing and serialisation

While the dev server is running, /parity.html compares how whiteboard Markdown boxes look when idle and while editing.

Project layout

src/
  apps/            app router
  pages/           page, workspace, QuickShare and settings screens
  layouts/         app shell, auth and encryption (secure context)
  render/editor/   TipTap editor, custom blocks and Markdown
  render/whiteboard/  tldraw canvas and encrypted persistence
  lib/             encrypted storage (IndexedDB) and the Drive sync engine
  components/      shared UI, import/export, search, trash, QuickShare
  drivesync/       Google Drive integration

Built with React, Vite, Tailwind CSS, TipTap, and tldraw. See AGENTS.md for in-depth architecture notes.

Contributing

Bug reports, feature requests, and small fixes are welcome through GitHub Issues. I'm not taking on dedicated contributors right now.

License

Mintype is licensed under the GNU Affero General Public License v3.0. Whiteboards use the tldraw SDK, which has its own license.

Additional permission under GNU AGPL version 3 section 7

If you modify this Program, or any covered work, by linking or combining it with the tldraw SDK (the tldraw and @tldraw/* packages, or a modified version of them), containing parts covered by the terms of the tldraw license, the licensors of this Program grant you additional permission to convey the resulting work. Corresponding Source for a non-source form of such a combination shall include the source code for the parts of the tldraw SDK used as well as that of the covered work.

This permission does not change the tldraw license itself: anyone running Mintype with tldraw must still meet its terms, including a license key for production deployments.

Support Mintype

Mintype is an independent project. If it is useful to you, please consider supporting it:

Star History

Star History Chart

About

A free, zero-knowledge note taking app :)

Topics

Resources

Stars

145 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Contributors

Languages

0