mirror of
https://github.com/johannesjo/super-productivity.git
synced 2026-07-20 18:08:55 +00:00
c2b18683d8
* 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.
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
# 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](https://nodejs.org))
|
|
- Git
|
|
|
|
### Local: Clone and Install
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
ng serve
|
|
```
|
|
|
|
Open [http://127.0.0.1:4200](http://127.0.0.1:4200). For most UI and frontend work this is enough. [Redux DevTools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) work in the browser.
|
|
|
|
### Local: Run the Full App (Electron)
|
|
|
|
```bash
|
|
ng serve
|
|
```
|
|
|
|
In a second terminal:
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
The Electron window will load the dev server.
|
|
|
|
## Option 2: GitHub Codespaces
|
|
|
|
1. Open the repository on GitHub.
|
|
2. Click **Code** → **Codespaces** → **Create codespace on main** (or the plus icon).
|
|
3. Wait for the dev container to build. The development server usually starts automatically.
|
|
4. 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](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
|
|
|
|
## Related
|
|
|
|
- [[2.16-Set-Up-Development-Environment]] (environment variables)
|
|
- [[2.12-Package-the-App]]
|