mirror of
https://github.com/aculix/negotium.git
synced 2026-09-11 07:28:17 +00:00
Aculix Technologies
e6dd24a046
Two things that were deliberately left out of 2.0.0. Export writes every stored day to a JSON file. Import reads one back, and only ever adds: a task whose id is already there is left alone, so importing the same file twice does nothing and importing into a list you're using can't lose work. That is also why it needs no confirmation dialog. The trade is that import restores rather than reverts. Both sit in a quiet line under the task list rather than the header, since they get used about twice a year and the header is what you look at all day. For the PWA half, the service worker is about fifty lines with no dependency, because the strategy falls out of how Vite builds. Documents go network first and fall back to cache, so a deploy is picked up as soon as you're online and nobody ends up stuck on an old build. Fingerprinted assets go cache first and are kept, since their names change when their contents do. No build-time asset manifest needed. Icons are SVG in the manifest, which stays sharp at any size and costs about a kilobyte, plus one 180px PNG because iOS wants a raster apple-touch-icon. Two theme-color metas so the phone status bar follows the theme, and safe-area padding on the header, without which the header sits under the clock once installed on an iPhone. Verified against the production build: worker registers and claims the page, shell and assets land in cache, and with the server stopped the app still loads, adds a task and persists it.
153 lines
6.2 KiB
Markdown
153 lines
6.2 KiB
Markdown
# Negotium - Minimalist To Do App
|
|
|
|
A beautiful, minimal to-do list application featuring smooth animations, intelligent date management, and a modern design that helps you stay organized and productive.
|
|
|
|
|
|
|
|
## 💭 Why Negotium?
|
|
|
|
While powerful tools like Trello and Vikunja excel at managing complex projects and long-term planning, sometimes you just need a simple, focused space for your daily tasks. That's why I built Negotium, a straightforward to-do list for today and tomorrow. Nothing more, nothing less.
|
|
|
|
Built with Svelte for speed and simplicity. No overwhelming features, no endless project boards, no complexity. Just a clean interface for your daily workflow.
|
|
|
|
## ✨ Features
|
|
|
|
### Core Functionality
|
|
- ✅ **Add, complete, and delete tasks** with smooth animations
|
|
- ↩️ **Undo** - `Cmd/Ctrl+Z` brings back a deleted task, in its original position
|
|
- 📅 **Today & Tomorrow lists** - Plan ahead with separate task lists
|
|
- 🔄 **Unfinished work carries over** - When a new day begins, tasks you didn't finish move to Today; completed ones are cleared away
|
|
- 🎯 **Reorder by drag or keyboard** - Drag with a mouse, long-press and drag on touch, or use `Alt+↑`/`Alt+↓`
|
|
- 💾 **Persistent storage** - All tasks saved locally in your browser
|
|
- 📊 **Task statistics** - See how many tasks remain at a glance
|
|
- 📱 **Installable and works offline** - Add it to your home screen or dock and it runs with no connection
|
|
- 📦 **Export and import** - Take your tasks with you, or keep a backup
|
|
|
|
## 🚀 Getting Started
|
|
|
|
### Quick Start with Docker (Recommended)
|
|
|
|
Pull and run the pre-built Docker image:
|
|
|
|
```bash
|
|
# Pull the image
|
|
docker pull ghcr.io/aculix/negotium:main
|
|
|
|
# Run the container
|
|
docker run -d -p 3000:80 --name negotium ghcr.io/aculix/negotium:main
|
|
```
|
|
|
|
Then open `http://localhost:3000` in your browser.
|
|
|
|
To stop the container:
|
|
```bash
|
|
docker stop negotium
|
|
docker rm negotium
|
|
```
|
|
|
|
### Manual Installation
|
|
|
|
If you prefer to run the application locally without Docker:
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone <repository-url>
|
|
cd negotium
|
|
```
|
|
|
|
2. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. Start the development server:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
4. Open `http://localhost:3000` in your browser
|
|
|
|
#### Build for Production
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
The optimized files will be in the `dist` directory.
|
|
|
|
#### Running the Tests
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
The date, storage, rollover, task and undo logic lives in `src/lib/` as plain modules that take the current time as an argument, so behaviour at a day boundary is covered by ordinary unit tests rather than by waiting for midnight.
|
|
|
|
## 📖 How to Use
|
|
|
|
### Managing Tasks
|
|
- **Add a task**: Type in the input field and press Enter
|
|
- **Complete a task**: Click the checkbox next to the task
|
|
- **Delete a task**: Hover over a task and click the delete icon, or press `Delete` with the task focused
|
|
- **Undo a delete**: Press `Cmd/Ctrl+Z`. The task returns to where it was
|
|
- **Reorder tasks**: Drag with a mouse, long-press then drag on touch, or focus a task and press `Alt+↑`/`Alt+↓`
|
|
- **Clear input**: Press Escape while the input is focused
|
|
|
|
### Date Management
|
|
- **Switch between Today and Tomorrow**: Click the date button in the header
|
|
- **Plan ahead**: Add tasks to Tomorrow's list before you need them
|
|
- **Separate lists**: Today and Tomorrow maintain independent task lists
|
|
- **Carry-over**: When a new day begins, whatever you didn't finish moves into Today. Completed tasks are cleared away with the day they belonged to. It works across gaps too. If you don't open Negotium for a week, everything still outstanding is waiting for you.
|
|
- **While it's open**: The app notices the day change on its own, so a tab left open overnight rolls over without a reload.
|
|
|
|
### Installing It
|
|
|
|
Negotium is a PWA, so it installs like an app and runs without a connection.
|
|
|
|
- **iPhone and iPad**: open it in Safari, tap Share, then Add to Home Screen
|
|
- **Android**: Chrome offers Install from the menu, or prompts you directly
|
|
- **Desktop**: Chrome and Edge show an install button in the address bar
|
|
|
|
Once installed it opens in its own window with no browser chrome, and works on a plane. The app never needed the network for anything beyond loading itself.
|
|
|
|
### Backing Up and Moving Between Devices
|
|
|
|
Everything lives in one browser's storage, so `Export` writes it all to a JSON file you can keep or carry somewhere else. `Import` reads that file back.
|
|
|
|
Import only ever adds. Tasks already present are left alone, so importing the same file twice changes nothing and importing into a list you're already using can't lose anything. The flip side is that import restores rather than reverts: it won't undo work you did after the export.
|
|
|
|
### Theme Toggle
|
|
- Click the sun/moon icon in the header to switch themes
|
|
- Your preference is saved automatically and restored on reload
|
|
- Respects system dark mode preference on first visit
|
|
|
|
### Keyboard Shortcuts
|
|
- **Enter**: Add task (when input is focused)
|
|
- **Escape**: Clear input field (when input is focused)
|
|
- **Space/Enter**: Toggle task completion (when a task's checkbox is focused)
|
|
- **Delete**: Delete the focused task
|
|
- **Cmd/Ctrl+Z**: Undo the last delete or clear-completed
|
|
- **Alt+↑ / Alt+↓**: Move the focused task up or down
|
|
|
|
Backspace no longer deletes a task. It is too easily pressed by accident, and deletions used to be unrecoverable.
|
|
|
|
## 💾 Data Storage
|
|
|
|
All data is stored locally in your browser using localStorage:
|
|
- **Tasks**: One key per date, in ISO form (`negotium-tasks-2026-08-15`)
|
|
- **Theme**: Your theme preference (`negotium-theme`)
|
|
- **No server required**: Everything runs entirely client-side
|
|
- **Privacy first**: Your data never leaves your device
|
|
- **Self-pruning**: Past days are removed as their unfinished tasks carry forward, so storage doesn't grow without bound
|
|
- **Yours to take**: Export writes everything to a JSON file, so your tasks aren't trapped in one browser
|
|
|
|
Earlier versions keyed tasks by a different date format (`negotium-tasks-Sat Aug 15 2026`). Those convert automatically the first time you open this version. Nothing to do, and nothing is lost.
|
|
|
|
## 📄 License
|
|
|
|
MIT License - Free for personal and commercial use.
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions are welcome! Feel free to submit issues and pull requests.
|