@@ -47,26 +47,24 @@ DevStack is a desktop tool for managing a local PHP / Apache / MySQL development
4747
4848Live project page: https://holdon1996.github.io/dev-stack/
4949
50+ It is built for developers who want a local stack manager without juggling multiple tools, shell scripts, or a full VM / container setup.
51+
5052It focuses on:
5153
5254- managing Apache, MySQL, PHP, Redis, and project services in one UI
5355- switching installed runtime versions without a heavy VM or container workflow
5456- handling virtual hosts, local sites, ports, logs, and quick config from one app
5557- shipping as a native Windows desktop app with tray support and auto-update support
5658
57- ## Highlights
59+ ## What You Can Do
5860
59- - Native Tauri v2 desktop app
60- - React + Zustand frontend
61- - Rust backend for process management, file operations, downloads, and system integration
62- - Apache version management
63- - PHP version management and per-project switching
64- - MySQL management and query execution
65- - Virtual host setup with hosts file sync
66- - Tunnel integrations page
67- - Log viewer for Apache, MySQL, PHP, and Redis
68- - Start with Windows support
69- - Native updater support for packaged releases
61+ - Start, stop, and monitor local services from one place
62+ - Switch PHP and Apache versions for different projects
63+ - Manage MySQL instances and run quick queries
64+ - Create and manage local sites and virtual hosts
65+ - Review Apache, MySQL, PHP, and Redis logs in the app
66+ - Configure startup behavior, ports, paths, editor, and updates
67+ - Keep the app updated through packaged releases
7068
7169## Main Sections
7270
@@ -79,72 +77,93 @@ It focuses on:
7977- ` Quick Config ` : shortcut actions for common setup tasks
8078- ` Settings ` : paths, ports, startup behavior, editor, and updates
8179
82- ## Tech Stack
80+ ## Quick Start
8381
84- - Tauri v2
85- - React 19
86- - Zustand
87- - Tailwind CSS
88- - Rust
82+ - Download the latest packaged build from [ Releases] ( https://github.com/holdon1996/dev-stack/releases/latest )
83+ - Run the ` .exe ` or ` .msi ` installer
84+ - Launch DevStack
85+ - Open ` Settings ` and configure your paths, ports, and local services
8986
90- ## Project Structure
87+ ## Screenshots
9188
92- ``` text
93- src/ React UI, state slices, hooks
94- src-tauri/ Rust commands, Tauri config, bundling
95- src/store/ Zustand slices for app domains
96- scripts/ Local helper scripts
97- .github/workflows/ Release automation
98- ```
89+ <p align =" center " >
90+ <img src =" docs/screenshots/services.png " alt =" DevStack Services " width =" 48% " >
91+ <img src =" docs/screenshots/sites.png " alt =" DevStack Sites " width =" 48% " >
92+ </p >
9993
100- ## Quick Start
94+ <p align =" center " >
95+ <img src =" docs/screenshots/php.png " alt =" DevStack PHP " width =" 48% " >
96+ <img src =" docs/screenshots/settings.png " alt =" DevStack Settings " width =" 48% " >
97+ </p >
10198
102- Want to install DevStack quickly?
99+ - ` Services ` : manage running services, ports, versions, and quick actions
100+ - ` Sites ` : create and manage local domains and project folders
101+ - ` PHP ` : switch runtimes and inspect installed versions
102+ - ` Settings ` : configure paths, startup behavior, ports, and updates
103103
104- - Download the latest packaged build from [ Releases] ( https://github.com/holdon1996/dev-stack/releases/latest )
105- - Run the ` .exe ` or ` .msi ` installer
106- - Open DevStack and configure your paths, ports, and local services in ` Settings `
104+ ## Who This README Is For
105+
106+ - If you only want to install and use DevStack, the sections above are enough
107+ - If you want to build, debug, or release the app, see the development notes below
108+
109+ <details >
110+ <summary ><strong >Development Notes</strong ></summary >
111+
112+ ## Development
107113
108114### Prerequisites
109115
110116- Node.js 20+
111117- Rust stable
112118- Windows
113119
114- ### Development
120+ ### Run In Development
115121
116122``` powershell
117123npm install
118124npm run tauri dev
119125```
120126
121- ### Production Build
127+ ### Build A Release
122128
123129``` powershell
124130npm run tauri build
125131```
126132
127- ## Releases And Auto Update
133+ ### Tech Stack
134+
135+ - Tauri v2
136+ - React 19
137+ - Zustand
138+ - Tailwind CSS
139+ - Rust
128140
129- Updater and release signing are already wired into the app and workflow.
141+ ### Project Structure
142+
143+ ``` text
144+ src/ React UI, state slices, hooks
145+ src-tauri/ Rust commands, Tauri config, bundling
146+ src/store/ Zustand slices for app domains
147+ scripts/ Local helper scripts for release and versioning
148+ .github/workflows/ Release automation
149+ ```
150+
151+ ### Release And Auto Update Notes
152+
153+ Release signing and updater flow are already wired into the app.
130154
131155- Release workflow: [ .github/workflows/release.yml] ( /f:/dev-stack/.github/workflows/release.yml )
132- - Local env helper: [ scripts/set-updater-env.ps1] ( /f:/dev-stack/scripts/set-updater-env.ps1 )
156+ - Local updater env helper: [ scripts/set-updater-env.ps1] ( /f:/dev-stack/scripts/set-updater-env.ps1 )
133157
134- If the repository is private, GitHub-hosted updater assets will not be publicly downloadable by end users. For the current updater URL strategy, the repository should be public or served through a separate update endpoint.
158+ If this repository is private, GitHub-hosted updater assets will not be publicly downloadable by end users. With the current updater URL strategy, the repository should stay public or use a separate update endpoint.
135159
136- ## Recommended Setup
160+ ### Recommended Setup
137161
138162- VS Code
139163- Tauri extension
140164- rust-analyzer
141165
142- ## Roadmap
143-
144- - Better release presentation and screenshots
145- - More automated runtime discovery
146- - Improved SSL and local certificate flow
147- - Better onboarding for first-time setup
166+ </details >
148167
149168## Star History
150169
@@ -156,5 +175,13 @@ If the repository is private, GitHub-hosted updater assets will not be publicly
156175
157176## Support
158177
159- - Issues: https://github.com/holdon1996/dev-stack/issues
160- - Releases: https://github.com/holdon1996/dev-stack/releases
178+ - Report bugs or request features: https://github.com/holdon1996/dev-stack/issues
179+ - Download packaged builds: https://github.com/holdon1996/dev-stack/releases
180+
181+ ### Donate
182+
183+ If DevStack is useful in your workflow, you can support the project here:
184+
185+ <p align =" center " >
186+ <img src =" qr-donate.png " alt =" Donate QR Code " width =" 260 " >
187+ </p >
0 commit comments