6 | Dead-simple menubar app for taking notes on your mac. 7 |
8 | 9 | ## Introduction 10 | 11 | This is a [Next.js](https://nextjs.org/) and [Tauri](https://tauri.app/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) and [`tauri init`](https://tauri.app/v1/guides/getting-started/setup/next-js/#create-the-rust-project). The text editor is an instance of [Tiptap](https://tiptap.dev/) bootstrapped using [Novel](https://novel.sh). The CSS is primarily [Tailwind](https://tailwindcss.com/docs). 12 | 13 | _Note: This repo is tested for macOS primarily, running on Windows may require additional debugging._ 14 | 15 | ## Getting Started 16 | 17 | First, make sure you are set up to run a Rust project. [Check documentation here](https://tauri.app/v1/guides/getting-started/prerequisites#setting-up-macos). 18 | 19 | Clone the repo, install depedancies, and run the development server: 20 | 21 | ```bash 22 | cd backend 23 | npm install 24 | npm run tauri dev 25 | ``` 26 | 27 | The local instance of the app should show in your menubar at this point. 28 | 29 | If you want to run the frontend only: 30 | 31 | ```bash 32 | cd frontend 33 | npm run dev 34 | ``` 35 | 36 | The local dev server will run on `http://localhost:3000`. 37 | 38 | ## Build an app 39 | 40 | To build an app ready to be installed and used locally, run the following code 41 | 42 | ```bash 43 | cd backend 44 | npm run tauri build 45 | ``` 46 | 47 | Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. 48 | 49 | ## Features 50 | 51 | - [x] Add global keyboard shortcut to toggle app 52 | - [x] `esc` hides app 53 | - [x] Add support for images 54 | - [ ] Add global reminders (reminders for tasks that are on a longer timescale) e.g: "Follow up with Adam on Monday" 55 | - [ ] Add timer in footer 56 | - [x] Add Supabase backend 57 | -------------------------------------------------------------------------------- /backend/.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | pnpm-debug.log* 8 | lerna-debug.log* 9 | 10 | node_modules 11 | dist 12 | dist-ssr 13 | *.local 14 | 15 | # Editor directories and files 16 | .vscode/* 17 | !.vscode/extensions.json 18 | .idea 19 | .DS_Store 20 | *.suo 21 | *.ntvs* 22 | *.njsproj 23 | *.sln 24 | *.sw? 25 | -------------------------------------------------------------------------------- /backend/.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": ["tauri-apps.tauri-vscode", "rust-lang.rust-analyzer"] 3 | } 4 | -------------------------------------------------------------------------------- /backend/README.md: -------------------------------------------------------------------------------- 1 | # Backend 2 | 3 | This project is bootstrapped with `create tauri-app` (Tauri + Vanilla TS). This directory is reponsible for creating the Tauri menubar window and for remotely calling the frontend using a URL. 4 | -------------------------------------------------------------------------------- /backend/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 |No Internet Connection.
49 | 55 |