README.md 7.03 KB
Newer Older
ransome1's avatar
ransome1 committed
1
2
# sleek
## sleek is a todo app based on todo.txt, free and open-source. Available for Linux, Windows and MacOS
3
+ [Screenshots](#screenshots)
4
+ [Support sleek](#support-sleek)
ransome1's avatar
ransome1 committed
5
6
7
8
+ [Get it from Microsoft Store](#get-sleek-from-microsoft-store)
+ [Get it from Snap Store](#get-sleek-from-snap-store)
+ [Get it from Flathub](#get-sleek-from-flathub)
+ [Get it from Arch User Repository](#get-sleek-from-arch-user-repository)
ransome1's avatar
ransome1 committed
9
+ [Download it](#download-sleek)
10
11
+ [Build it from source code](#build-sleek-from-source-code)
+ [State of development](#sleeks-state-of-development)
12
13
14
+ [Features](#features)
+ [Used libraries](#used-libraries)

ransome1's avatar
ransome1 committed
15
sleek is an open-source todo app that makes use of the todo.txt format. sleeks GUI is modern and simple but still offers a decent set of functions which help users getting things done. sleek is available as a client for Windows, MacOS and Linux.
ransome1's avatar
ransome1 committed
16

17
Users can add contexts, projects, priorities, due dates, recurrences or threshold dates to their todos. These todo.txt attributes can then be used in full-text search, as filters or to group and sort the todo list.
ransome1's avatar
ransome1 committed
18

19
sleek manages and watches multiple todo.txt files continuously for changes, which makes it easy to integrate sleek with other todo.txt apps. Also users can switch to dark mode and choose from multiple languages.
ransome1's avatar
ransome1 committed
20

ransome1's avatar
ransome1 committed
21
Todos with due date or repeating todos will trigger notifications and completed todos can be hidden or archived into separate done.txt files. If users have tons of todos, a compact view can come in handy.
ransome1's avatar
ransome1 committed
22

23
### Screenshots
24
25
![Alt text](assets/screenshots/linux/todo_list.png?raw=true "Screenshot of sleek's main view on Linux")
![Alt text](assets/screenshots/linux/multiline_autocomplete_dark.png?raw=true "Screenshot of sleek's auto complete function and multi line todo feature on Linux")
ransome1's avatar
ransome1 committed
26

27
28
29
30
### Support sleek
* Star, fork and watch it on Github. Once sleek reaches **30 watchers, 30 forks and 75 stars**, we can distribute it to MacOS using the <a href="https://github.com/Homebrew/brew" target="blank">Homebrew Package Manager</a>
* Review it on <a href="https://sourceforge.net/projects/sleek/reviews" target="blank">SourceForge</a> or <a href="https://www.microsoft.com/store/apps/9NWM2WXF60KR" target="blank">Windows Store</a>
* Contribute <a href="https://github.com/ransome1/sleek/issues">bug reports, code improvements, features or simply suggest new features</a>
31
* Translate sleek into your own language and contribute your translations
ransome1's avatar
ransome1 committed
32

33
### Get sleek from Microsoft Store
ransome1's avatar
ransome1 committed
34
35
You can install sleek from Microsofts Windows Store

36
<a href="//www.microsoft.com/store/apps/9NWM2WXF60KR?cid=storebadge&ocid=badge" target="blank"><img src='https://developer.microsoft.com/store/badges/images/English_get-it-from-MS.png' alt='English badge' width='180'/></a>
ransome1's avatar
ransome1 committed
37

38
### Get sleek from Snap Store
ransome1's avatar
ransome1 committed
39
40
41
42
You can install sleek from Canonicals Snap Store using: `sudo snap install sleek`

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/sleek)

43
### Get sleek from Flathub
44
Install sleek from <a href="https://flathub.org/apps/details/com.github.ransome1.sleek" target="blank">Flathub</a> using: `flatpak install flathub com.github.ransome1.sleek`
ransome1's avatar
ransome1 committed
45
46
47

Run it using: `flatpak run com.github.ransome1.sleek`

48
<a href="https://flathub.org/apps/details/com.github.ransome1.sleek" target="blank"><img width='180' alt="Download on Flathub" src="https://flathub.org/assets/badges/flathub-badge-en.png"/></a>
ransome1's avatar
ransome1 committed
49

50
51
52
53
### Get sleek from Homebrew
Install sleek from <a href="https://formulae.brew.sh/cask/sleek" target="blank">Homebrew</a>.
`brew install --cask sleek`

54
### Get sleek from Arch User Repository
55
56
57
Install sleek from <a href="https://aur.archlinux.org/packages/sleek/" target="blank">AUR</a>.
1. Setup <a href="https://github.com/Jguer/yay#installation" target="blank">Yay</a>
2. `yay -S sleek`
ransome1's avatar
ransome1 committed
58

59
### Download sleek
ransome1's avatar
ransome1 committed
60
You can download sleek for Windows, MacOS and Linux from
61
- <a href="https://sourceforge.net/p/sleek/" target="blank">SourceForge</a>
ransome1's avatar
ransome1 committed
62
63
- <a href="https://github.com/ransome1/sleek/releases/latest">Github</a>

64
### Build sleek from source code
ransome1's avatar
ransome1 committed
65
1. Setup <a href="https://docs.github.com/en/github/getting-started-with-github/set-up-git" target="blank">Git</a>, <a href="https://nodejs.org/" target="blank">node.js</a> and <a href="https://yarnpkg.com/getting-started" target="blank">yarn</a>.
66
2. Clone sleek `git clone https://github.com/ransome1/sleek.git` and cd into sleeks directory
ransome1's avatar
ransome1 committed
67
3. Install dependencies `yarn install --production`
ransome1's avatar
ransome1 committed
68
4. Build sleek `yarn build:windows` or `yarn build:linux` or `yarn build:macos`
69

ransome1's avatar
ransome1 committed
70
71
### sleeks state of development
A prioritized backlog of new features and known issues can be found <a href="https://github.com/ransome1/sleek/projects/2">here</a>.
ransome1's avatar
ransome1 committed
72
73
74

### Features
* An existing todo.txt file can be used or a new one can be created
75
* Todos can be enriched and searched for by
76
77
78
79
80
  - priorities
  - contexts
  - projects
  - due dates
  - start dates
81
82
  - <a href="https://github.com/ransome1/sleek/wiki/Recurring-todos-(rec:)">recurrences</a>
  - <a href="https://github.com/ransome1/sleek/wiki/Deferred-todos-(t:)">thresholds</a>
83
* Todo-List can be grouped and sorted by priorities, due dates, contexts or projects
ransome1's avatar
ransome1 committed
84
* The sorting order can be defined on all 4 levels
85
86
87
88
89
* Todos can be filtered by contexts, projects and priorities
* Todos can be looked up by full-text search
* Autocomplete function suggests available contexts and projects
* <a href="https://github.com/ransome1/sleek/wiki/Keyboard-shortcuts">Keyboard shortcuts following todotxt.net</a>
* Tabindex available
90
* <a href="https://github.com/ransome1/sleek/wiki/Hidden-todos">A todo can be hidden but its attributes will be available in the filter drawer and autocomplete function</a>
91
* Due dates trigger alarms and appear as badges in sleeks icon
ransome1's avatar
ransome1 committed
92
93
94
95
96
* Dark and light mode can be toggled
* A compact view is available
* Completed todos can be bulk archived to a separate done.txt ([name of todo file]_done.txt) file
* Completed todos can be shown or hidden
* Multi line todos can be created
ransome1's avatar
ransome1 committed
97
* Filters can be renamed or deleted by right clicking on them
98
* Filters are sorted alphanummerically
ransome1's avatar
ransome1 committed
99
100
101
* Hyperlinks are detected automatically and can be clicked using the icon
* A file watcher rereads the todo.txt file if it has been changed
* Multiple todo.txt files can be managed
102
* Multiple languages are either detected or can be set by hand to
ransome1's avatar
ransome1 committed
103
104
105
106
107
  - English
  - German
  - Italian
  - Spanish
  - French
108
109
  - Simplified Chinese
  - Brazilian Portugese
ransome1's avatar
ransome1 committed
110
  - Japanese
ransome1's avatar
ransome1 committed
111
* sleek can be minimized to tray
ransome1's avatar
ransome1 committed
112
113
114
115
116
117
118
119
120
121
122
123
* Existing todos can be used as templates for new ones

### Used libraries
- Electron: https://github.com/electron/electron
- Electron builder: https://github.com/electron-userland/electron-builder
- Bulma CSS: https://github.com/jgthms/bulma
- Font Awesome: https://github.com/FortAwesome/Font-Awesome
- jsTodoTxt: https://github.com/jmhobbs/jsTodoTxt
- Marked: https://github.com/markedjs/marked
- vanillajs-datepicker: https://github.com/mymth/vanillajs-datepicker
- i18next: https://github.com/i18next/i18next
- Matomo: https://github.com/matomo-org/matomo
124
- chokidar: https://github.com/paulmillr/chokidar
Daniel Weisser's avatar
Daniel Weisser committed
125
- Sugar: https://github.com/andrewplummer/Sugar