Skip to content

Commit a8c0c84

Browse files
authored
Merge pull request #96 from Starmania/drop-rimraf
Update and remove dependencies
2 parents 263fcf5 + 9d2c7ff commit a8c0c84

File tree

11 files changed

+428
-524
lines changed

11 files changed

+428
-524
lines changed

.compilerc

Lines changed: 0 additions & 46 deletions
This file was deleted.

.nvmrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
lts/jod
2+
3+
# 22.20.0

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to HTTP Toolkit Desktop
2+
3+
Thanks for helping improve HTTP Toolkit. This document explains the quickest way to get started working on the desktop shell and how to contribute changes.
4+
5+
Prerequisites
6+
7+
- Node: >= 22 (this repo targets Node 22.x). We recommend using nvm to manage Node versions.
8+
- To use the pinned version (if you have nvm installed):
9+
- nvm install # installs the version in .nvmrc
10+
- nvm use
11+
- Or use your system Node if it meets the minimum version requirement.
12+
13+
To get started
14+
15+
- Clone this repo.
16+
- Install dependencies: `npm install`
17+
- To build & run the electron app locally:
18+
- `npm start` - runs the desktop app, downloading the latest live server & using the live UI from `app.httptoolkit.tech`.
19+
- Useful when working on just the desktop app and you want to test against the real live environment.
20+
- `npm run start:dev` - runs the desktop app with no built-in server, using the UI from `http://localhost:8080`.
21+
- Useful when you're running a local UI and/or server and want the desktop shell to host that UI.
22+
- To work on the UI and see it inside the desktop app, start the UI project (https://github.com/httptoolkit/httptoolkit-ui) with `npm start`.
23+
- Alternatively, run the server project (https://github.com/httptoolkit/httptoolkit-server) with `npm start`, and `npm run start:web` in the UI project to run server + UI locally.
24+
- To build distributable packages:
25+
- `npm run build` - builds & packages the desktop app for your current platform.
26+
27+
A few tips
28+
29+
- Electron dev behaviour isn't identical to production build behaviour — verify changes in a real built version too.
30+
- Most distributable build configuration lives in the `build` field of `package.json`.- CI pull requests do not receive secret environment variables, so packaging-related builds may fail in CI for PRs. This is expected — maintainers will manually build and evaluate such PR changes when necessary.
31+
32+
Reporting issues
33+
34+
- For bugs or feature requests related to HTTP Toolkit itself, prefer filing issues at the main repo: https://github.com/httptoolkit/httptoolkit/
35+
- For issues specific to this desktop shell (packaging, Electron behaviour, installers), open an issue in this repo.
36+
37+
Making changes & pull requests
38+
39+
- Create a feature branch from main for each change.
40+
- Keep PRs focused and include a clear description of the problem and your solution.
41+
- Ensure the TypeScript compiles: `npm run build:src`
42+
- If your change affects packaging or build steps, include instructions to reproduce locally.
43+
- CI must pass before merging; maintainers will review and merge.
44+
45+
Coding style & tests
46+
47+
- This project is TypeScript. Follow existing code patterns and style.
48+
- Run the TypeScript compiler to check for errors: `npm run build:src`

README.md

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,32 +31,13 @@ The builds themselves are done on GitHub Actions, and tagged `main` builds are a
3131

3232
If you want to change the behaviour of the HTTP Toolkit desktop shell (but not its contents), change how it's built, or add a new target platform or format, then you're in the right place :+1:.
3333

34-
To get started:
35-
36-
* Clone this repo.
37-
* `npm install`
38-
* To build & run the electron app locally:
39-
* `npm start` - runs the desktop app, downloading the latest live server & using the live UI from `app.httptoolkit.tech`.
40-
* This is useful if you're working on just the desktop app, and want to see your changes with the real live environment.
41-
* `npm run start:dev` - runs the desktop app, with no built-in server using the UI from `localhost:8080`
42-
* This effectively assumes you're bringing your own working UI & server, and is useful for working on this.
43-
* You can start both from the [UI project](https://github.com/httptoolkit/httptoolkit-ui) with just `npm start`, to work on the UI within the desktop app.
44-
* Alternatively, you can run `npm start` in the [server project](https://github.com/httptoolkit/httptoolkit-server), and `npm run start:web` in the UI project, to work on the server or both.
45-
* To build distributable packages:
46-
* `npm run build` - this will attempt to build & package the desktop app for your current platform
47-
48-
A few tips:
49-
50-
* Electron dev behaviour isn't identical to production build behaviour, make sure you check your changes in a real built version.
51-
* Most distributable build configuration is in under the `build` field in [`package.json`](./package.json).
52-
* To fully build packages, you may find some platforms complain about that signing certificates are required. You'll probably need to unset fields like `forceCodeSigning` to disable that.
53-
* In CI, pull requests don't receive secret environment variables, so builds may fail. Confirm that that's what's happening, and if so that's ok - the team will manually build & evaluate PR changes to resolve this.
34+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started contributing to this repo.
5435

5536
## License
5637

5738
The HTTP Toolkit desktop application source code is licensed under AGPL-3.0, [as documented in this repo](/LICENSE).
5839

59-
The binary downloads available in this repo or from [httptoolkit.com](https://httptoolkit.com) however may be used under one of two licenses:
40+
The binary downloads available in this repo or from [httptoolkit.com](https://httptoolkit.com) however may be used under one of two licenses:
6041

6142
* [AGPL-3.0](/LICENSE), for those who want to modify and redistribute them, within the constraints of that license.
6243
* [Creative Commons Attribution-NoDerivatives 4.0 International License](https://creativecommons.org/licenses/by-nd/4.0/) for those who don't need those rights and want to avoid any concerns about AGPL licensing.

0 commit comments

Comments
 (0)