Skip to content

Latest commit

 

History

History
400 lines (284 loc) · 18.8 KB

README.md

File metadata and controls

400 lines (284 loc) · 18.8 KB
Raw
Banner

An advanced todo list app with timeboxing & time tracking capabilities that supports importing tasks from your calendar, Jira, GitHub and others

🌐 Open Web App or 💻 Download


animated



Stand With Ukraine

MIT license GitHub All Releases Chocolatey package On product hunt Reddit Community Super Productivity on Mastodon tweet

Get it from the Snap Store English badge App Store Badge Play Store Badge F-Droid Badge


✔️ Features

  • Keep organized and focused! Plan and categorize your tasks using sub-tasks, projects and tags and color code them as needed.
  • Use timeboxing and track your time. Create time sheets and work summaries in a breeze to easily export them to your company's time tracking system.
  • Helps you to establish healthy & productive habits:
    • A break reminder reminds you when it's time to step away.
    • The anti-procrastination feature helps you gain perspective when you really need to.
    • Need some extra focus? A Pomodoro timer is also always at hand.
    • Collect personal metrics to see, which of your work routines need adjustments.
  • Integrate with Jira, GitHub, GitLab, Gitea and OpenProject. Auto import tasks assigned to you, plan the details locally, automatically create work logs, and get notified immediately, when something changes.
  • Attach context information to tasks and projects. Create notes, attach files or create project-level bookmarks for links, files, and even commands.
  • Super Productivity respects your privacy and does NOT collect any data and there are no user accounts or registration. You decide where you store your data!
  • It's free and open source and always will be.

And much more!

Work View with global links

❓ How to use it

If you need some help, this article on dev.to is the best place to start.

If you prefer, there is also a (long) YouTube video available.

There is another older – the app looks and feels much better now ;) – article on how I personally might use the app - and still another one on how I implement the 'eat the frog' prioritizing scheme in the app.

If you have further questions, please refer to the discussions page.

⌨ Keyboard shortcuts and short-syntax

Keyboard shortcuts (most important)

  • Shift+A: Open add task bar
  • Enter: Edit currently focussed task title
  • Arrow keys: Navigate around task list
  • D: Mark currently focused task as done
  • A: Add subtask to currently focused task
  • Y: Toggle tracking time to currently focused task
  • S: Open schedule dialog for currently focused task
  • Backspace: Delete currently focused task
  • ArrowRight: Open additional info panel for currently focused task
  • Ctrl+Shift+ArrowUp: Move currently focused task up in list
  • Ctrl+Shift+ArrowDown: Move currently focused task down in list

Short-Syntax

Can be used when adding a task. (Each of these can be disabled in settings->short syntax)

  • # <tag-name>: add a tag to the task
    ("task-description #tag1")
  • <number>m or <number>h: set time-estimate for the task
    ("task-description 10m" or "task-description 5h")
  • @<time>: add due time to the task ("task-description @fri 10pm")
  • + <project-name>: add the task to an existing project
    ("task-description +Important Project")
  • Ctr + 2: toggle between moving the new task to the bottom and top of the list

🌐 Web Version

Check out the web version even though it is a bit limited: Time tracking only works if the app is open and for idle time tracking to work, the chrome extension must be installed.

If you want the Jira integration and idle time tracking to work, you also have to download and install the Super Productivity Chrome Extension.

💻 Downloads & Install

All Platforms

Install from the releases page.

Windows

Due to certification issues it's recommended to download the app from the Microsoft Store:

English badge

You can also install the app using Chocolatey:

choco install super-productivity

Linux

Snap - Most distributions

Install via command-line:

# stable
sudo snap install superproductivity

# edge channel releases
sudo snap install --channel=edge superproductivity

# it is also recommended to disable updates to the app while it is running:
sudo snap set core experimental.refresh-app-awareness=true
Get it from the Snap Store

Aur - Arch Linux

git clone https://aur.archlinux.org/superproductivity-bin.git
cd superproductivity-bin
makepkg -si

MacOS

Install via homebrew cask:

brew install --cask superproductivity
App Store Badge

Android

A new version of the Android app is now available with Connectivity-Free Mode, allowing you to use the app without an internet connection.

This update offers more flexibility, supporting both fully offline usage and integration with services like WebDAV and Dropbox for syncing. Enjoy a smoother, more reliable experience whether you're online or offline.

Stay tuned for even more exciting updates!

You can find the Android app here:

App Store Badge F-Droid Badge

The sources can be found here.

♥️ Contributing

Please check out the CONTRIBUTING.md

There are several ways to help.

  1. Spread the word: More users mean more people testing and contributing to the app which in turn means better stability and possibly more and better features. You can vote for Super Productivity on Slant, Product Hunt, Softpedia or on AlternativeTo, you can tweet about it, share it on LinkedIn, reddit or any of your favorite social media platforms. Every little bit helps!

  2. Provide a Pull Request: Here is a list of the most popular community requests and here some info on how to run the development build. Please make sure that you're following the angular commit guidelines and to also include the issue number in your commit message, if you're fixing a particular issue (e.g.: feat: add nice feature with the number #31).

  3. Answer questions: You know the answer to another user's problem? Share your knowledge!

  4. Provide your opinion: Some community suggestions are controversial. Your input might be helpful and if it is just an up- or down-vote.

  5. Provide a more refined UI spec for existing feature requests

  6. Report bugs

  7. Make a feature or improvement request: Something can be done better? Something essential missing? Let us know!

  8. Translations, Icons, etc.: You don't have to be programmer to help. Some of the icons really need improvement and many of the translations could use some love.

inlang status badge

You can use the Fink Localization Editor to edit, lint, and add translations for different languages. Contribute via fink Guide.

  1. Sponsor the project

Running the development server

To run the development server you need to have node installed at least in the version 14. Go to https://nodejs.org for installation instructions.

Clone repo

git clone https://github.com/johannesjo/super-productivity.git

Install dependencies

cd super-productivity
npm i -g @angular/cli
npm i

Run the dev server

ng serve

Afterwards you can open http://localhost:4200 in your browser. For most adjustments this should be enough and also enables you to use the redux dev tools.

If you want to run the app standalone do the following:

ng serve

# in a new console tab
npm start

Packaging the app

Packaging the app is done via electron-builder. To start packaging run npm run dist. If you want to add new platforms and experiment with the build options the easiest way to do so is manipulating the build property in the package.json, but you can also use the command line interface of electron builder.

Building for Android

This feature was added on October 7, 2024. See Pull Request #57.

To build the Android version of Super Productivity, please refer to the Android Build Documentation, which includes instructions on configuring Connectivity-Free Mode and Online-Only Mode (Compatibility Mode).

Ensure you follow the setup steps properly to configure the environment for building the app.

Run as Docker Container

docker run -d -p 80:80 johannesjo/super-productivity:latest

Now you can access the web app from your browser at http://localhost.

This container only serves the web app, and the user data is stored in the browser. Therefore, it does not have any persistent storage.

Integrate with WebDAV backend server

You can integrate the container with a WebDAV server container to provides WebDAV service with base url http://localhost/webdav.

Download pre-configured files

Download the pre-configured docker-compose.yaml and webdav.yaml from this repository to a local directory, say sp/.

# Alternatively, you can get them by cloning this repository
git clone https://github.com/johannesjo/super-productivity.git
mkdir -p sp
cp super-productivity/docker-compose.yaml sp/
cp super-productivity/webdav.yaml sp/
cd sp

Setup user accounts

Edit webdav.yaml to configure username and password. Remember to create and assign different directories to different users (within /data) to avoid mixing up user data.

Start the services

docker compose pull
docker compose up -d

Additionally to accessing the web app from your browser at http://localhost, you can set up WebDAV synchronization with base url http://localhost/webdav/.

Custom themes (desktop only)

In addition to color coding your projects and tags and to the dark and light theme you can also load completely custom css to restyle everything. To load a custom theme you simply need put them into a new file named styles.css directly in the user data folder.

There is a great set of themes available for download in this repository as well as some info on how to create your own custom themes.

Custom WebDAV Syncing

If using the integrated WebDAV Syncing is not working out for you, you can also try to sync all app files, which are located in the user data folder.

Automatic Backups

For the desktop version automatic backups are stored per default in the backup sub folder of the user data folder. Once you located a backup you can restore it on the settings page under Sync & Export/Import/Export/Import from file.

User Data Folder

Where user data is stored differs from OS to OS. The most common locations are:

OS Location
Mac OS ~/Library/Application Support/superProductivity/
Windows C:\Users\<YOUR_USER_NAME>\AppData\Roaming\superProductivity/ or %APPDATA%\superProductivity
Linux ~/.config/superProductivity/

The path should be shown when you go to the "Automatic Backups` section on the configuration page (minus the "backup" sub folder). You can also see it printed out when you start the app from the command line.

For web browsers, data is simply stored for the current user inside the browser storage.

Using a custom folder to save user data

You can specify a custom folder for saving your data by starting the application with the --user-data-dir parameter like so:

superproductivity --user-data-dir=/path/to/my/data