|
| 1 | +Nocturnote is a sleek, modern, and highly customizable note-taking application built with Electron, Svelte, TypeScript, and Tailwind CSS. |
| 2 | +It offers a distraction-free writing environment with powerful features. |
| 3 | + |
| 4 | + |
| 5 | +> Notepad Mode in Nocturnote |
| 6 | + |
| 7 | +**Key Features:** |
| 8 | +* **Customizable Interface:** Adjust font family, size, weight, line height, word wrap, and line numbers. |
| 9 | +* **File Management:** Create new notes, open existing `.txt` or `.md` files, and save work. |
| 10 | +* **Search and Replace:** Quickly find and replace text. |
| 11 | +* **Notepad Mode:** Classic notepad aesthetic. |
| 12 | +* **Rain Mode:** A unique visual effect. |
| 13 | +* **Status Bar:** Displays line/column, character count, and encoding. |
| 14 | +* **Cross-Platform:** Runs seamlessly across different operating systems. |
| 15 | + |
| 16 | +**Technologies Used:** |
| 17 | +* **Electron:** For cross-platform desktop applications. |
| 18 | +* **Svelte:** Modern JavaScript framework for UIs. |
| 19 | +* **TypeScript:** For type-safe JavaScript. |
| 20 | +* **Tailwind CSS:** Utility-first CSS framework. |
| 21 | +* **electron-vite:** Fast development setup for Electron apps. |
| 22 | + |
| 23 | +**Installation:** |
| 24 | +Requires Node.js and npm/yarn. |
| 25 | +1. Clone the repository: `git clone https://github.com/fezcode/nocturnote.git` |
| 26 | +2. Navigate to the directory: `cd nocturnote` |
| 27 | +3. Install dependencies: `npm install` |
| 28 | + |
| 29 | +**Usage:** |
| 30 | +* **Development:** `npm run dev` |
| 31 | +* **Building:** `npm run build` (creates distributable packages in `out` directory) |
| 32 | + * Specific platforms: `npm run build:win`, `npm run build:mac`, `npm run build:linux` |
| 33 | +* **Other Scripts:** `npm run format`, `npm run lint`, `npm run typecheck` |
| 34 | + |
| 35 | +**License:** Distributed under the MIT License. |
| 36 | + |
| 37 | +**Project Link:** [https://github.com/fezcode/nocturnote](https://github.com/fezcode/nocturnote) |
0 commit comments