Skip to content

aynavbar/Spark

Repository files navigation

Spark

A quick notes inerface that saves to a Notion page

Getting started

Clone the repo (git clone <repository-url>) or download the ZIP

Set up

  1. Create a new internal connection at Notion's Developer portal

    • Click on "New connection"
    • Give the connection a name
    • Select "Access token"
    • Select your workspace
    • Click on "Create connection"
  2. Get your access token

    • You'll find this on the "Configuration" tab on the newly created connection
  3. Give your connection page permissions

    • Pick (or create) a Notion page.
    • Click on the ... More menu in the top-right corner of the page.
    • Scroll down to + Add Connections.
    • Search for your connection and select it.
    • Confirm the connection can access the page and all of its child pages.
  4. Create a database

    • In your Notion page, create a database and open it in fullscreen to get the database ID from the URL field in your browser. It's right after p/ and right before ?v
    • Add the following fields
    Field Datatype Options
    Note Text -
    Type Select Person, Project, Reference, Idea
    Status Status New, Maybe, Discard
    Created Created time -
  5. Add both the access token and database ID as NOTION_KEY and PUBLIC_NOTION_DATABASE_ID respectively to your conputer's user environment variables

  6. Open the repository in the terminal and install dependencies with npm install

    • Note: The app is built in Tauri so having Rust installed is required. Refer to this guide for your specific OS if you don't have it intalled already
  7. You can run the app directly with npm run tauri dev or build a release with npm run tauri build

The app opens with the shortcut Ctrl+Shift+Space or Command+Shift+Space if you're on MacOS and assuming there isn't any other app that has that shortcut registered. If it does, open src/lib/main.ts on line 50 and change it. A future release will have a settings menu for easy configuration

The flow is Shortcut → Type → Enter. The window disappears as soon as you click the return key, ready for another note.

Known bugs

Drag area: The input pill's drag area messes with the window's focused state causing the window to hide

Other bug reports should be reported in Github Issues for this repository

Future plans

  • Adding a settings menu (see the settings_page branch)
  • Implementing single instance
  • A proper release workflow
  • A website for non-technical users that might find this useful

About

My attempt at a quick-capture notes interface for Notion on Windows

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors