mirror of https://github.com/johannesjo/super-productivity.git synced 2026-07-18 00:46:45 +00:00

* docs(wiki): add new Quickstart to help with using Sync

There is a slew of notes that try to explain or show this so a
Quickstart can help bring everything into one place.

* docs(wiki): combine "First Steps" into single note with relevant links

* docs(wiki): update index notes

* docs(wiki): fix remaining broken external links

* docs(wiki): add core developer How-To guides to orient first-time devs

The majority of the documentation is currently spread across several
files ins "docs/" and READMEs. Over time these can be consolidated into
the wiki while retaining the common CONTRIBUTING.md as a valid entry
point.

* docs(wiki): add basic guides for plugins and issue integration

As with the core development docs, there is too much to add here right
now. These notes will serve as a simple entry to other resources.

* docs(wiki): add basic reference note for theming

* docs(wiki): add basic Translation guide

* docs(wiki): rename Theming and linting to clean up headings

* docs(wiki): add heading lint exception for GH-specific nav pages; rework sidebar and index pages

Sidebar should be a quick-access for the more common topics grouped
thematically with the X.00 notes simply enumerating all the notes where
appropriate.

2026-02-20 21:13:38 +01:00

1.7 KiB

Raw Permalink Blame History

Run the Development Server

How to run Super Productivity locally for development, or in GitHub Codespaces.

Option 1: Local

Prerequisites

Node.js 20 or higher (nodejs.org)
Git

Local: Clone and Install

git clone https://github.com/super-productivity/super-productivity.git
cd super-productivity
npm i -g @angular/cli
npm i
npm run env

npm run env creates or updates the environment file once; re-run if you add or change variables.

Local: Start the Frontend

ng serve

Open http://127.0.0.1:4200. For most UI and frontend work this is enough. Redux DevTools work in the browser.

Local: Run the Full App (Electron)

ng serve

In a second terminal:

npm start

The Electron window will load the dev server.

Option 2: GitHub Codespaces

Open the repository on GitHub.
Click Code → Codespaces → Create codespace on main (or the plus icon).
Wait for the dev container to build. The development server usually starts automatically.
Open the Ports tab, find the forwarded port (e.g. 4200), and use Open in Browser or Ctrl+Click the URL to open the app.

VS Code settings sync in the codespace. To change the dev environment, edit .devcontainers/devcontainers.json per Codespaces documentation.

2.16-Set-Up-Development-Environment (environment variables)
2.12-Package-the-App

1.7 KiB Raw Permalink Blame History