Skip to content

Commit b5c11e4

Browse files
authored
Revise README with state management details
Updated README to enhance clarity and added new section on state management.
1 parent f893feb commit b5c11e4

1 file changed

Lines changed: 36 additions & 16 deletions

File tree

README.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</p>
1717

1818
<p align="center">
19-
<em>Tired of manually setting up full-stack projects every time? <br>
19+
<em>Tired of manually setting up full-stack projects every time? 😩<br>
2020
Say hello to <b>Hackpack</b> — your all-in-one project bootstrapper that turns setup time into build time </em>
2121
</p>
2222

@@ -30,16 +30,13 @@
3030

3131
</div>
3232

33-
---
34-
3533
## What is Hackpack?
3634

3735
**Hackpack** is a powerful CLI tool that scaffolds hackathon-ready full-stack applications in seconds. Stop wasting time on repetitive setup — let the CLI handle your project structure, UI libraries, databases, authentication, and more with a single command
3836

3937
```bash
4038
npm i -g hackpack-cli
4139
```
42-
---
4340

4441
## Features
4542

@@ -137,9 +134,6 @@ Launch your project in seconds with a single command — skip the setup, focus o
137134

138135
</div>
139136

140-
141-
---
142-
143137
## Quick Start
144138

145139
### Installation
@@ -168,8 +162,6 @@ The interactive wizard will guide you through:
168162
- Authentication setup
169163
- UI library preferences
170164

171-
---
172-
173165
## CLI Commands
174166

175167
### Core Commands
@@ -225,7 +217,38 @@ hp autocomplete install
225217
# Follow the instructions for your shell
226218
```
227219

228-
---
220+
## Understanding State in Hackpack
221+
222+
Hackpack keeps track of your setup progress and project preferences using a persistent state file. This is especially useful when:
223+
224+
- You stop midway during setup (e.g., terminal closes unexpectedly)
225+
- You want to resume an incomplete setup
226+
- You're managing **multiple projects** at the same time
227+
228+
The state is stored in a hidden `.hackpack-state.json` file (in your project folder or home directory), and it keeps track of configuration choices and setup progress.
229+
230+
### What Does Hackpack Save in State?
231+
232+
- **Project Name**
233+
- **Framework** (React, Next.js, Angular, etc.)
234+
- **Styling & UI libraries** (shadcn/ui, DaisyUI, etc.)
235+
- **Database** (MongoDB, PostgreSQL)
236+
- **Authentication** (Clerk, Supabase, etc.)
237+
- **Setup Step Tracking** (for resume support)
238+
239+
Each project you create gets its own state and can be resumed or configured independently!
240+
241+
### Commands That Use State
242+
243+
| Command | Purpose |
244+
|------------------------|---------|
245+
| `hp` | Start a new project with a clean state |
246+
| `hp run` | Builds or continues setup for the active project |
247+
| `hp resume` | Resume the last project setup from where you left off |
248+
| `hp select <project>` | Switch between saved projects before running/resuming |
249+
| `hp state` | View all saved project states and active project |
250+
| `hp reset` | Completely clears all saved state (fresh start) |
251+
229252

230253
## Supported Stacks
231254

@@ -261,7 +284,7 @@ Clerk • Supabase (coming soon) • Auth0 (AngularJS)
261284

262285
## Contributing
263286

264-
We love contributions! Whether it's a bug report, feature request, or pull request — all are welcome.
287+
We love contributions! Whether it's a bug report, feature request, or pull request — all are welcome
265288

266289
### Found a Bug?
267290

@@ -272,15 +295,12 @@ Open an issue with:
272295
- Expected vs actual behavior
273296
- Your environment (OS, Node version, etc.)
274297

275-
---
276-
277298
## License
278299

279-
Distributed under the **Proprietary License**. See <a href="https://github.com/YashVerma-code/hackpack/blob/main/LICENSE.md">LICENSE</a> for more information.
280-
281-
---
300+
Distributed under the **Proprietary License**. See <a href="https://github.com/YashVerma-code/hackpack/blob/main/LICENSE.md">LICENSE</a> for more information
282301

283302
## Acknowledgments
284303

285304
By TeamHackpack ( Varun & Yash ) — because setup time is coding time wasted!
286305
<div>
306+

0 commit comments

Comments
 (0)