-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnocturnote.txt
More file actions
68 lines (48 loc) · 2.3 KB
/
nocturnote.txt
File metadata and controls
68 lines (48 loc) · 2.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
Nocturnote is a sleek, modern, and highly customizable note-taking application designed for the minimalists who crave power. Built with the robustness of **Electron** and the agility of **Svelte**, it bridges the gap between a simple scratchpad and a full-fledged editor.
> "A distraction-free writing environment that adapts to your state of flow, not the other way around."
## Visual Showcase

## Core Philosophy
Nocturnote was born from a frustration with bloated text editors. It focuses on:
* **Immediacy:** Opens instantly.
* **Clarity:** UI that recedes when you're typing.
* **Flexibility:** From a retro "Notepad" aesthetic to a cyberpunk "Rain Mode".
## Key Features
* **Customizable Typography:** Fine-tune your font family, size, weight, and line height to match your reading preferences.
* **Seamless File Management:** Native support for `.txt` and `.md` files with auto-save capabilities.
* **Advanced Search:** Regex-powered search and replace for power users.
* **Visual Modes:** Switch between a classic light aesthetic or the immersive dark mode with digital rain effects.
* **Information Bar:** Real-time stats on line/column position, character count, and file encoding.
## Architecture & Tech Stack
Nocturnote leverages a modern stack to ensure performance and cross-platform compatibility:
* **Electron:** Provides the native desktop shell.
* **Svelte:** Delivers a reactive, DOM-efficient UI without the virtual DOM overhead.
* **TypeScript:** Ensures code reliability and maintainability.
* **Tailwind CSS:** Enables rapid styling and theming.
* **Electron-Vite:** A blazing fast build tool optimized for Electron development.
## Getting Started
### Installation
Ensure you have Node.js installed, then:
```bash
# Clone the repository
git clone https://github.com/fezcode/nocturnote.git
# Navigate to the directory
cd nocturnote
# Install dependencies
npm install
```
### Development
To start the app in development mode with hot-reloading:
```bash
npm run dev
```
### Building for Production
Create distributable binaries for your OS:
```bash
# Build for all platforms
npm run build
# Or specific platforms
npm run build:win
npm run build:mac
npm run build:linux
```