You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-16Lines changed: 36 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@
16
16
</p>
17
17
18
18
<palign="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>
20
20
Say hello to <b>Hackpack</b> — your all-in-one project bootstrapper that turns setup time into build time </em>
21
21
</p>
22
22
@@ -30,16 +30,13 @@
30
30
31
31
</div>
32
32
33
-
---
34
-
35
33
## What is Hackpack?
36
34
37
35
**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
38
36
39
37
```bash
40
38
npm i -g hackpack-cli
41
39
```
42
-
---
43
40
44
41
## Features
45
42
@@ -137,9 +134,6 @@ Launch your project in seconds with a single command — skip the setup, focus o
137
134
138
135
</div>
139
136
140
-
141
-
---
142
-
143
137
## Quick Start
144
138
145
139
### Installation
@@ -168,8 +162,6 @@ The interactive wizard will guide you through:
168
162
- Authentication setup
169
163
- UI library preferences
170
164
171
-
---
172
-
173
165
## CLI Commands
174
166
175
167
### Core Commands
@@ -225,7 +217,38 @@ hp autocomplete install
225
217
# Follow the instructions for your shell
226
218
```
227
219
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.
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
265
288
266
289
### Found a Bug?
267
290
@@ -272,15 +295,12 @@ Open an issue with:
272
295
- Expected vs actual behavior
273
296
- Your environment (OS, Node version, etc.)
274
297
275
-
---
276
-
277
298
## License
278
299
279
-
Distributed under the **Proprietary License**. See <ahref="https://github.com/YashVerma-code/hackpack/blob/main/LICENSE.md">LICENSE</a> for more information.
280
-
281
-
---
300
+
Distributed under the **Proprietary License**. See <ahref="https://github.com/YashVerma-code/hackpack/blob/main/LICENSE.md">LICENSE</a> for more information
282
301
283
302
## Acknowledgments
284
303
285
304
By TeamHackpack ( Varun & Yash ) — because setup time is coding time wasted!
0 commit comments