README.md 7.81 KB
Newer Older
ransome1's avatar
ransome1 committed
1
# sleek
ransome1's avatar
ransome1 committed
2
3

## Help wanted
ransome1's avatar
ransome1 committed
4
Amazing feature requests, major and minor bug reports are piling up, and great discussions are ongoing. I want to thank you for supporting this project. But I also need to admit that I'm overwhelmed by the sheer amount of work. Please understand that sleek is FOSS and I'm not aiming to earn money with it, so my time on the project is limited. If you are skilled in HTML, CSS, JavaScript, the Electron framework, writing Playwright test cases, improving UX/UI or if you're able to maintain sleek for one of the distribution channels, please check in with me <a href="https://github.com/ransome1/sleek/discussions/388">here</a> or check the <a href="https://github.com/ransome1/sleek/issues">issue list</a> and start working on bugs and feature requests.
ransome1's avatar
ransome1 committed
5

6
## sleek is an open-source (FOSS) todo manager based on the todo.txt syntax. It's available for Windows, MacOS and Linux
7
+ [Screenshots](#screenshots)
8
+ [Support sleek](#support-sleek)
9
+ [Get it from Mac App Store](#get-sleek-from-apple-mac-app-store)
ransome1's avatar
ransome1 committed
10
11
12
+ [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)
13
+ [Get it from Homebrew](#get-sleek-from-homebrew)
ransome1's avatar
ransome1 committed
14
+ [Get it from Arch User Repository](#get-sleek-from-arch-user-repository)
ransome1's avatar
ransome1 committed
15
+ [Download it](#download-sleek)
16
17
+ [Build it from source code](#build-sleek-from-source-code)
+ [State of development](#sleeks-state-of-development)
18
19
20
+ [Features](#features)
+ [Used libraries](#used-libraries)

21
sleek is an open-source (FOSS) todo manager based on the todo.txt syntax. Stripped down to only the most necessary features, and with a clean and simple interface, sleek aims to help you focus on getting things done.
ransome1's avatar
ransome1 committed
22

23
All classic todo.txt attributes are supported and enhanced by additional features. Creating todos is straightforward, and tag-based filtering in tandem with highly customisable grouping and smart full-text search allow for rapid information retrieval. Completed todos can be hidden or archived into separate done.txt files. Easy integration with other todo.txt apps is facilitated by continuously scanning todo.txt files for changes.
ransome1's avatar
ransome1 committed
24

25
sleek is available for Windows, MacOS and Linux, and in several languages. For a detailed list of features, see below.
ransome1's avatar
ransome1 committed
26

27
### Screenshots
ransome1's avatar
ransome1 committed
28
29
![Alt text](assets/screenshots/mac/main.png?raw=true "Screenshot of sleek's todo list view")
![Alt text](assets/screenshots/mac/drawer.png?raw=true "Screenshot of sleek's auto complete function and multi line todo feature")
30
31
32

### sleeks state of development
A prioritized backlog of new features and known issues as well as an overview on what is being worked on at the moment can be found <a href="https://github.com/ransome1/sleek/projects/2">here</a>.
ransome1's avatar
ransome1 committed
33

34
### Support sleek
35
* Star, fork and watch it on Github.
36
37
* Review it on <a href="https://apps.apple.com/us/app/sleek-todo-manager/id1614704209" target="blank">Mac App Store</a>, <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>
* <a href="https://github.com/ransome1/sleek/blob/master/CONTRIBUTING.md">Contribute to sleek</a>
ransome1's avatar
ransome1 committed
38
39


40
41
42
43
### Get sleek from Apple Mac App Store
<a href="https://apps.apple.com/us/app/sleek-todo-manager/id1614704209" target="blank"><img src='assets/store_badges/Download_on_the_Mac_App_Store.png' alt='Get sleek from Apple Mac App Store' width='180'/></a>

### Get sleek from Microsoft Store
44
<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
45

46
### Get sleek from Snap Store
ransome1's avatar
ransome1 committed
47
48
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/sleek)

49
50
Install sleek from <a href="https://snapcraft.io/sleek" target="blank">Snap Store</a> using: `sudo snap install sleek`

51
### Get sleek from Flathub
52
53
<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>

54
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
55
56
57

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

58
59
60
61
### Get sleek from Homebrew
Install sleek from <a href="https://formulae.brew.sh/cask/sleek" target="blank">Homebrew</a>.
`brew install --cask sleek`

62
### Get sleek from Arch User Repository
63
64
65
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
66

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

72
### Build sleek from source code
ransome1's avatar
ransome1 committed
73
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>.
74
2. Clone sleek `git clone https://github.com/ransome1/sleek.git` and cd into sleeks directory
ransome1's avatar
ransome1 committed
75
3. Install dependencies `yarn install --production`
ransome1's avatar
ransome1 committed
76
4. Build sleek `yarn build:windows` or `yarn build:linux` or `yarn build:macos`
77

ransome1's avatar
ransome1 committed
78
### Features
79
80
* Uses existing todo.txt files or creates new ones
* Add and search for todos by
81
82
83
84
  - priorities
  - contexts
  - projects
  - due dates
85
  - creation dates
86
87
88
89
90
91
92
93
  - recurrences (repeating todos)
  - threshold dates
* Sort and group todos by priority, due and creation date, context and project or as they occur in the text file
* Filter todos by context, project and priority
* Find todos using full-text search compatible with todo.txt syntax
* Inline autocomplete available
* Dates and priorities can be selected by built-in picker elements 
* Navigable via keyboard shortcuts
94
* Tabindex available
95
96
97
98
* Options for due date reminders and notification badges
* Easily toggle between dark and light mode
* Compact view and zoom available
* Completed todos can be shown, hidden and archived
ransome1's avatar
ransome1 committed
99
* Multi line todos can be created
100
101
102
103
104
* Filters are sorted alphanummerically and can be renamed or deleted
* Hyperlinks detected automatically
* File watcher scans todo.txt files for changes
* Simultaneously manage multiple todo.txt files
* Language options
ransome1's avatar
ransome1 committed
105
106
107
108
109
  - English
  - German
  - Italian
  - Spanish
  - French
110
111
  - Simplified Chinese
  - Brazilian Portugese
ransome1's avatar
ransome1 committed
112
  - Japanese
ransome1's avatar
ransome1 committed
113
  - Turkish
114
  - Hungarian
PapuleX's avatar
PapuleX committed
115
  - Czech
116
  - Polish
117
118

A more detailed documentation can be found in <a href="https://github.com/ransome1/sleek/wiki/">sleeks wiki</a>.
ransome1's avatar
ransome1 committed
119
120
121
122

### Used libraries
- Electron: https://github.com/electron/electron
- Electron builder: https://github.com/electron-userland/electron-builder
123
124
125
- Electron Notarize: https://github.com/electron/electron-notarize
- Electron Windows Badge: https://github.com/viktor-shmigol/electron-windows-badge
- electron-reloader: https://github.com/sindresorhus/electron-reloader
ransome1's avatar
ransome1 committed
126
127
128
129
130
131
- 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
132
- i18next-fs-backend: https://github.com/i18next/i18next-fs-backend
ransome1's avatar
ransome1 committed
133
- Matomo: https://github.com/matomo-org/matomo
134
- chokidar: https://github.com/paulmillr/chokidar
Daniel Weisser's avatar
Daniel Weisser committed
135
- Sugar: https://github.com/andrewplummer/Sugar
136
- PEG.js: https://github.com/pegjs/pegjs
137
138
139
- Playwright: https://github.com/microsoft/playwright 
- Sass: https://github.com/sass/sass
- eslint: https://github.com/eslint/eslint