Skip to content

Commit d624706

Browse files
committed
chore(release): release and readme updates
1 parent 78565ac commit d624706

File tree

11 files changed

+694
-83
lines changed

11 files changed

+694
-83
lines changed

.github/release-drafter.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name-template: "v$NEXT_PATCH_VERSION"
2+
tag-template: "v$NEXT_PATCH_VERSION"
3+
categories:
4+
- title: "🚀 Features"
5+
labels:
6+
- feature
7+
- enhancement
8+
- title: "🐛 Fixes"
9+
labels:
10+
- bug
11+
- fix
12+
- title: "🧰 Chores"
13+
labels:
14+
- chore
15+
- maintenance
16+
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
17+
template: |
18+
## What's Changed
19+
20+
$CHANGES
21+
22+
_This release was drafted automatically._

.github/workflows/release.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: "Release Devbox"
2+
3+
on:
4+
push:
5+
branches:
6+
- release
7+
8+
jobs:
9+
publish-tauri:
10+
permissions:
11+
contents: write
12+
strategy:
13+
fail-fast: false
14+
matrix:
15+
settings:
16+
- platform: "macos-latest"
17+
args: "--target x86_64-apple-darwin"
18+
- platform: "macos-latest"
19+
args: "--target aarch64-apple-darwin"
20+
- platform: "ubuntu-22.04"
21+
args: ""
22+
- platform: "windows-latest"
23+
args: ""
24+
25+
runs-on: ${{ matrix.settings.platform }}
26+
steps:
27+
- uses: actions/checkout@v4
28+
29+
- name: install dependencies (ubuntu only)
30+
if: matrix.settings.platform == 'ubuntu-22.04'
31+
run: |
32+
sudo apt-get update
33+
sudo apt-get install -y libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
34+
35+
- name: setup node
36+
uses: actions/setup-node@v4
37+
with:
38+
node-version-file: package.json
39+
node-version: lts/*
40+
cache: "yarn"
41+
42+
- name: install Rust
43+
uses: dtolnay/rust-toolchain@stable
44+
with:
45+
targets: ${{ matrix.settings.platform == 'macos-latest' && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }}
46+
47+
- name: Rust cache
48+
uses: swatinem/rust-cache@v2
49+
with:
50+
workspaces: "./src-tauri -> target"
51+
52+
- name: install ui dependencies
53+
run: yarn install --immutable
54+
55+
- name: install UPX
56+
if: matrix.settings.platform != 'macos-latest'
57+
uses: crazy-max/ghaction-upx@v3
58+
with:
59+
install-only: true
60+
61+
- uses: tauri-apps/tauri-action@v0
62+
env:
63+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
64+
TAURI_SIGNING_PRIVATE_KEY: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY }}
65+
TAURI_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY_PASSWORD }}
66+
VITE_GA_MEASUREMENT_ID: ${{ secrets.GA_MEASUREMENT_ID }}
67+
with:
68+
tagName: devbox-v__VERSION__
69+
releaseName: "Devbox v__VERSION__"
70+
releaseBody: "Download and install the latest version of Devbox."
71+
prerelease: false
72+
releaseDraft: true
73+
args: ${{ matrix.settings.args }}

CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# 1.0.0 (2025-08-16)
2+
3+
### Features
4+
5+
- add new tools - ids, ssh and svg preview 8a534f0
6+
- BackslashEscape tool addition 56e9f2d
7+
- bundlephobia tool addition e02515e
8+
- Certificate decoder tool addition 7d6908b
9+
- cron builder tool c63caf1
10+
- data faker tool addition 9e685d2
11+
- Diff editor tool addition e773feb
12+
- DNS Tool addition 657697e
13+
- epoch tool addition a0cc424
14+
- graphiql addition 54fc740
15+
- har file viewer tool dcbf34f
16+
- hide or unhide tools in settings 11b7c06
17+
- HMAC generator addition 04bd4bf
18+
- initial starter with jwt tool d7816dd
19+
- JSON Formatter tool addition 547eb29
20+
- markdown tool addition 0db7ab7
21+
- module based grouping of tools a26c618
22+
- New Dashboard with RSS Feed e302bc7
23+
- regex tool addition e244b66
24+
- rest debug tool addition 4c0c9e1
25+
- support for persistent store in browser f1ef8ee
26+
- Timezone tool addition 102e6c7
27+
- URL Parser and Decode tools 7de062e

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 smithg09
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 86 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,75 @@ Devbox helps you work faster by centralizing common developer workflows: inspect
1919

2020
- **Cross‑platform desktop**: Powered by Tauri for a small footprint and native performance.
2121
- **Web app**: Use it in the browser with a fast Vite dev server and static build.
22-
- **Productivity‑first UI**: Group and reorder tools, hide what you don’t use, and get to work quickly.
22+
- **Productivity‑first UI**: Reorder tools, hide what you don’t use, group them modules and get to work quickly.
2323
- **Dashboard**: See recently used tools and follow your own RSS feeds.
2424
- **Offline‑friendly**: Most tools work entirely locally; network tools only connect when you use them.
25-
- **No fluff**: Purpose‑built tools with sensible defaults.
25+
- **No fluff / no filler**: Only tools developers actually reach for daily—focused, fast, and maintained (no novelty widgets).
2626

27-
### Currently Available Tools
27+
### Installation
2828

29-
- **Authentication & Security**: JWT Inspector, HMAC Generator, X.509 Certificate Decoder
30-
- **Data & Formats**: JSON Formatter, Backslash Escape/Unescape, URL Parser, URL Encoder, EPOCH Converter, Timezone
31-
- **Networking**: REST Client, GraphiQL Client, HAR Viewer, DNS Lookup, SSH Key tools
32-
- **Dev Utilities**: Regex Tester, Cron Builder & Parser, ID Generators, SVG Viewer, Bundle Analyzer
29+
> Binaries will be published with the first public release. Paths below are placeholders until then.
3330
34-
> Installation and downloads will be added after the first public release.
31+
Download the latest release for your platform from the (upcoming) [GitHub Releases page](https://github.com/your-org/devbox/releases)
32+
33+
After installing, launch Devbox and start using tools immediately—no sign‑in, anonymous usage counts stored locally.
34+
35+
### Available Tools
36+
37+
#### Network
38+
39+
- GraphiQL – Explore schemas, run queries, debug responses
40+
- REST Client – Compose & send HTTP requests
41+
- HAR Viewer – Inspect performance waterfalls & request details
42+
- DNS Lookup – Query records across resolvers
43+
44+
#### Security
45+
46+
- JWT Tools – Decode & inspect JSON Web Tokens
47+
- HMAC Generator – Compute signatures (Web Crypto)
48+
- Certificate Decoder – Parse X.509 certificates / CSRs
49+
- Hashing Text – Compute hashes for input text
50+
- SSH Keys – Generate & validate SSH key pairs
51+
52+
#### Utilities
53+
54+
- Timezone – Multi‑zone time scrubber with persistence
55+
- Regex Tester – Live highlighting & match exploration
56+
- Cron – Build, parse, and preview cron expressions
57+
- Bundle Analyzer – Inspect npm package size & exports
58+
59+
#### Generators
60+
61+
- Stateless Password – Deterministic site passwords (no storage)
62+
- QuickType – Generate types / interfaces from JSON
63+
- Data Faker – Mock data from schema or visual builder
64+
- ID Generator – UUID, NanoID, custom patterns
65+
66+
#### Viewers
67+
68+
- Markdown – Live preview & export
69+
- Diff – Monaco diff for text / JSON / code
70+
- SVG Preview – Inspect & optimize SVG
71+
- HTML/CSS Preview – Live HTML playground
72+
73+
#### Formatters
74+
75+
- JSON Formatter – Pretty print & tree explorer
76+
- SQL Formatter – Format SQL queries
77+
- JS/TS Minifier – Minify JavaScript / TypeScript
78+
- CSS Minifier – Minify CSS
79+
- HTML Minifier – Minify HTML
80+
81+
#### Converters
82+
83+
- JSON ⇄ YAML – Bi‑directional conversion
84+
- Backslash Escape – Escape / unescape sequences
85+
- URL Parser – Parse & edit URL components
86+
- URL Encoder – Encode / decode URLs
87+
- Base64 – Encode / decode text
88+
- Epoch Converter – Epoch ↔ human time
89+
90+
> Planned: WebSocket Client, Mock API Server / Webhook tester.
3591
3692
## Getting Started
3793

@@ -65,56 +121,28 @@ Access app from the browser at `http://localhost:3001`
65121
yarn tauri build
66122
```
67123

68-
## Roadmap
69-
70-
### Features
71-
72-
- [x] Move tool position
73-
- [x] Quick access icon on menu
74-
- [x] Grouped tools
75-
- [x] Hide/Unhide tools
76-
- [x] Dashboard
77-
- [x] Frequently used tools
78-
- [x] Add Custom RSS Feed
79-
- [ ] Smart clipboard
80-
81-
### Tools
82-
83-
- [x] JWT
84-
- [x] Markdown
85-
- [x] SVG
86-
- [x] Cron
87-
- [x] ID Generator
88-
- [x] Regex Tester
89-
- [x] Bundle Analyzer
90-
- [x] SSH
91-
- [x] HAR Viewer
92-
- [x] REST API Testing
93-
- [x] GraphiQL
94-
- [x] EPOCH Converter
95-
- [x] URL Parser
96-
- [x] URL Encoder
97-
- [x] HMAC Generator
98-
- [x] Backslash Escape/Unescape
99-
- [x] DNS Lookup Tool
100-
- [x] Certificate Decoder X.509
101-
- [x] JSON Formatter
102-
- [x] Timezone
103-
- [x] Diff tools
104-
- [x] Base64 Text (encode/decode)
105-
- [x] HTM/CSS Preview
106-
- [x] JSON <> YAML
107-
- [x] Hashing Text
108-
- [x] Quick Type
109-
- [x] SQL Formatter
110-
- [x] HTML Formatter
111-
- [x] CSS Formatter
112-
- [x] JS/TS Formatter
113-
- [x] Stateless password
114-
- [x] Data Faker
115-
- [ ] WebSocket Client
116-
- [ ] Mock API Server / Webhook test
124+
### Inspiration
125+
126+
Devbox draws conceptual inspiration from modern multi‑tool developer workbenches. Special thanks to:
127+
128+
- **devtools-x** – For pioneering the idea of a cohesive, high‑performance toolbox and influencing early architectural choices (sidebar ergonomics, and tech stack direction).
129+
- **devutils** – For further inspiration on focused, single‑purpose utility design and polished UX details.
130+
131+
Devbox builds on those ideas with a unified dashboard (usage‑aware surfacing + RSS), stronger module abstraction, no filler tools and an offline‑first Tauri desktop focus.
117132

118133
## Contributing
119134

120-
We welcome contributions! Issues for bugs, UX polish, or new tools are all appreciated. Development setup and installation documentation will be added alongside the initial release.
135+
We welcome contributions! We're especially looking to improve:
136+
137+
- **UX / UI polish** – Interaction flow, keyboard shortcuts, accessibility, visual consistency, dark/light contrast.
138+
- **Performance** – Faster startup, smaller bundle size, memory efficiency, render minimization.
139+
- **Essential new tools** – Only high‑signal utilities devs actually use daily (no novelty / filler). Open an issue first to discuss scope & fit.
140+
- **Cross‑platform parity** – macOS, Linux, Windows nuances (menus, drag regions, file dialogs, notifications).
141+
- **Module quality** – Better defaults, validation, helpful empty states, clearer errors.
142+
- **Documentation** – Usage tips, adding a new tool module, troubleshooting.
143+
144+
Before implementing a new tool, please file an issue describing: the problem it solves, expected users, overlap with existing tools, and proposed module placement. We bias toward depth & quality over breadth.
145+
146+
To run locally, follow the [Getting Started](#getting-started) section (clone → `yarn install``yarn start`). Web build also runs from the same dev server.
147+
148+
Bug reports, focused PRs, profiling traces, and thoughtful design discussions are all appreciated.
File renamed without changes.

package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "devbox",
3-
"version": "0.1.1",
3+
"version": "1.0.0",
44
"license": "MIT",
55
"type": "module",
66
"scripts": {
@@ -12,7 +12,9 @@
1212
"lint:format": "prettier --log-level warn --write \"./**/*.{js,jsx,ts,tsx,css,md,json}\" ",
1313
"lint": "yarn lint:format && yarn lint:fix ",
1414
"lint-staged": "lint-staged",
15-
"prepare": "husky"
15+
"prepare": "husky",
16+
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
17+
"update-version": "./scripts/update-version.sh"
1618
},
1719
"dependencies": {
1820
"@faker-js/faker": "^9.9.0",
@@ -105,6 +107,7 @@
105107
"@vitejs/plugin-react": "^4.2.1",
106108
"@vitejs/plugin-react-swc": "^3.6.0",
107109
"@wyw-in-js/vite": "^0.5.0",
110+
"conventional-changelog-cli": "^5.0.0",
108111
"cross-env": "^7.0.3",
109112
"eslint": "^8.57.0",
110113
"eslint-config-prettier": "^9.1.0",

0 commit comments

Comments
 (0)