Skip to content

Commit 290662c

Browse files
authored
Revise README for Hackpack branding and features
Updated README to reflect new features and branding.
1 parent 285750e commit 290662c

1 file changed

Lines changed: 105 additions & 119 deletions

File tree

README.md

Lines changed: 105 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<div align="center">
22

3-
# 🚀 Hackpack
3+
<img width="744" height="172" alt="hp-img" src="https://github.com/user-attachments/assets/6768dc69-b0c6-420d-baf6-4b2c1f87b111" />
44

55
<p align="center">
6-
<a href="https://github.com/YOUR_GITHUB_USERNAME/hackpack">
7-
<img src="https://readme-typing-svg.herokuapp.com?font=Fira+Code&size=32&duration=2800&pause=2000&color=00FF00&center=true&vCenter=true&width=700&lines=Bootstrap+Full-Stack+Apps+Fast;One+Command.+Full+Setup.;Focus+on+Building%2C+Not+Configuring" alt="Hackpack Typing Animation">
6+
<a href="https://github.com/YashVerma-code/hackpack">
7+
<img src="https://readme-typing-svg.herokuapp.com?font=Fira+Code&size=32&duration=2400&pause=1800&color=00FF00&center=true&vCenter=true&width=700&lines=Bootstrap+Full-Stack+Apps+Fast;One+Command.+Full+Setup." alt="Hackpack Typing Animation">
88
</a>
99
</p>
1010

@@ -16,8 +16,8 @@
1616
</p>
1717

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

2323
<p align="center">
@@ -32,75 +32,122 @@
3232

3333
---
3434

35-
## 🎯 What is Hackpack?
35+
## What is Hackpack?
3636

37-
**Hackpack** is a powerful CLI tool that scaffolds production-ready full-stack applications in seconds. Stop wasting time on repetitive setup — let Hackpack handle your project structure, UI libraries, databases, authentication, and more with a single command.
37+
**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
3838

3939
```bash
4040
npm i -g hackpack-cli
4141
```
42-
43-
That's it. Your project is ready to go. 🎉
44-
4542
---
4643

47-
## Features
44+
## Features
4845

4946
<table align="center">
5047
<tr>
5148
<td>
49+
50+
**Lightning-Fast Setup**
51+
Spin up full projects in seconds
5252

53-
**Lightning Fast Setup**
54-
Generate complete projects in under 30 seconds
55-
56-
🧱 **Modern Frameworks**
57-
React, Next.js, Astro, Vue, Nuxt, Angular and Svelte.
58-
59-
🎨 **Pre-configured UI**
60-
shadcn/ui, DaisyUI, Material, Hero UI & many more.
53+
**Modern Frameworks**
54+
React, Next.js, Astro, Vue, Nuxt, Angular and Svelte
6155

56+
**Pre-configured UI**
57+
shadcn/ui, DaisyUI, Material, Hero UI & many more
6258
</td>
63-
<td>
6459

65-
🗄️ **Database Ready**
60+
<td>
61+
62+
**Database Ready**
6663
MongoDB, PostgreSQL support out of the box
6764

68-
🔐 **Auth Integration**
69-
Clerk authentication pre-configured
65+
**Auth Integration**
66+
Clerk and more, ready to use out of the box
7067

71-
📦 **Package Manager Agnostic**
72-
Works with npm, yarn, or pnpm
68+
**Your Hackathon Superpower**
69+
Launch your project in seconds with a single command — skip the setup, focus on building and winning the hackathon
7370

7471
</td>
7572
</tr>
7673
</table>
7774

7875
<div align="center">
7976

80-
### 🏗️ Full Stack Support
81-
82-
| Frontend | Backend | Database | Auth | UI Libraries |
83-
|:--------:|:-------:|:--------:|:----:|:------------:|
84-
| ✅ React (Vite) | ✅ Node.js | ✅ MongoDB | ✅ Clerk | ✅ shadcn/ui |
85-
| ✅ Next.js | ✅ Express | 🔜 PostgreSQL (beta) | 🔜 Supabase | ✅ DaisyUI |
86-
| ✅ Astro | 🔜 Prisma | 🔜 MySQL | 🔜 Auth0 | ✅ Material UI |
87-
| ✅ Vue | 🔜 NestJS | 🔜 SQLite | | ✅ Hero UI |
88-
| ✅ Nuxt | 🔜 FastAPI | | | ✅ Ant Design many more |
89-
| ✅ Angular | 🔜 Django | | | |
90-
| ✅ Svelte
77+
### Full Stack Support
78+
79+
<table>
80+
<tr>
81+
<th>Frontend</th>
82+
<th>Backend</th>
83+
<th>Database</th>
84+
<th>Auth</th>
85+
<th>UI Libraries</th>
86+
</tr>
87+
<tr>
88+
<td align="left">✅ React (Vite)</td>
89+
<td align="left">✅ Node.js</td>
90+
<td align="left">✅ MongoDB</td>
91+
<td align="left">✅ Clerk</td>
92+
<td align="left">✅ shadcn/ui</td>
93+
</tr>
94+
<tr>
95+
<td align="left">✅ Next.js</td>
96+
<td align="left">✅ Express</td>
97+
<td align="left">🔜 PostgreSQL (beta)</td>
98+
<td align="left">🔜 Supabase</td>
99+
<td align="left">✅ DaisyUI</td>
100+
</tr>
101+
<tr>
102+
<td align="left">✅ Astro</td>
103+
<td align="left">🔜 Prisma</td>
104+
<td align="left">🔜 MySQL</td>
105+
<td align="left">🔜 Auth0</td>
106+
<td align="left">✅ Material UI</td>
107+
</tr>
108+
<tr>
109+
<td align="left">✅ Vue</td>
110+
<td align="left">🔜 NestJS</td>
111+
<td align="left">🔜 SQLite</td>
112+
<td align="left"></td>
113+
<td align="left">✅ Hero UI</td>
114+
</tr>
115+
<tr>
116+
<td align="left">✅ Nuxt</td>
117+
<td align="left">🔜 FastAPI</td>
118+
<td align="left"></td>
119+
<td align="left"></td>
120+
<td align="left">✅ Ant Design & more</td>
121+
</tr>
122+
<tr>
123+
<td align="left">✅ Angular</td>
124+
<td align="left">🔜 Django</td>
125+
<td align="left"></td>
126+
<td align="left"></td>
127+
<td align="left"></td>
128+
</tr>
129+
<tr>
130+
<td align="left">✅ Svelte</td>
131+
<td align="left"></td>
132+
<td align="left"></td>
133+
<td align="left"></td>
134+
<td align="left"></td>
135+
</tr>
136+
</table>
91137

92138
</div>
93139

140+
94141
---
95142

96-
## 🚀 Quick Start
143+
## Quick Start
97144

98145
### Installation
99146

100147
```bash
101148

102149
# Install globally
103-
npm install -g hackpack
150+
npm install -g hackpack-cli
104151

105152
# Then run
106153
hp
@@ -115,17 +162,17 @@ hp
115162
```
116163

117164
The interactive wizard will guide you through:
118-
- 📁 Project name and location
119-
- 🎨 Framework selection (React, Next.js, Vue, etc.)
120-
- 🗄️ Database choice (MongoDB, PostgreSQL)
121-
- 🔐 Authentication setup
122-
- 🎭 UI library preferences
165+
- Project name and location
166+
- Framework selection (React, Next.js, Vue, etc.)
167+
- Database choice (MongoDB, PostgreSQL)
168+
- Authentication setup
169+
- UI library preferences
123170

124171
---
125172

126-
## 🧰 CLI Commands
173+
## CLI Commands
127174

128-
### 📜 Core Commands
175+
### Core Commands
129176

130177
| Command | Description |
131178
|---------|-------------|
@@ -136,7 +183,7 @@ The interactive wizard will guide you through:
136183
| `hp resume` | Resume an interrupted or incomplete setup |
137184
| `hp run` | Execute setup for the currently selected project |
138185

139-
### 🔧 Project Management
186+
### Project Management
140187

141188
| Command | Description |
142189
|---------|-------------|
@@ -147,13 +194,9 @@ The interactive wizard will guide you through:
147194
| `hp uninstall ui <library>` | Remove an installed UI library |
148195
| `hp migrate` | 🔜 Migrate project to newer template versions |
149196

150-
### 💡 Usage Examples
197+
### Usage Examples
151198

152199
```bash
153-
# Select and run a project
154-
hp select my-awesome-app
155-
hp run
156-
157200
# Add UI libraries on the fly
158201
hp add ui shadcn
159202
hp add ui daisyui
@@ -166,7 +209,7 @@ hp projects
166209
hp state
167210
```
168211

169-
### Autocomplete Support
212+
### Autocomplete Support
170213

171214
Speed up your workflow with terminal autocompletion:
172215

@@ -181,56 +224,21 @@ hp autocomplete install
181224

182225
# Follow the instructions for your shell
183226
```
184-
## 🧠 Understanding State in Hackpack
185-
186-
Hackpack keeps track of your setup progress and project preferences using a persistent state file. This is especially useful when:
187-
188-
- You stop midway during setup (e.g., terminal closes unexpectedly)
189-
- You want to resume an incomplete setup
190-
- You're managing **multiple projects** at the same time
191-
192-
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.
193-
194-
### ✅ What Does Hackpack Save in State?
195-
196-
- 📝 **Project Name**
197-
- ⚙️ **Framework** (React, Next.js, Angular, etc.)
198-
- 🎨 **Styling & UI libraries** (shadcn/ui, DaisyUI, etc.)
199-
- 🗄️ **Database** (MongoDB, PostgreSQL)
200-
- 🔐 **Authentication** (Clerk, Supabase, etc.)
201-
- 🧱 **Setup Step Tracking** (for resume support)
202-
203-
Each project you create gets its own state and can be resumed or configured independently!
204-
205-
### 🔧 Commands That Use State
206-
207-
| Command | Purpose |
208-
|------------------------|---------|
209-
| `hp` | Start a new project with a clean state |
210-
| `hp run` | Builds or continues setup for the active project |
211-
| `hp resume` | Resume the last project setup from where you left off |
212-
| `hp select <project>` | Switch between saved projects before running/resuming |
213-
| `hp state` | View all saved project states and active project |
214-
| `hp reset` | Completely clears all saved state (fresh start) |
215227

216228
---
217229

218-
219-
---
220-
221-
222-
## 🎨 Supported Stacks
230+
## Supported Stacks
223231

224232
### Frontend Frameworks
225233

226234
```
227-
React (Vite) • Next.js • Astro • Vue • Nuxt • Angular
235+
React (Vite) • Next.js • Astro • Vue • Nuxt • Angular • SvelteKit
228236
```
229237

230238
### Backend Technologies
231239

232240
```
233-
Node.js • Express • Prisma • NestJS (coming soon) • FastAPI (coming soon)
241+
Node.js • Express • Prisma (coming soon) • NestJS (coming soon) • FastAPI (coming soon)
234242
```
235243

236244
### UI Libraries
@@ -248,14 +256,13 @@ MongoDB • PostgreSQL (beta) • MySQL (coming soon) • SQLite (coming soon)
248256
### Authentication
249257

250258
```
251-
Clerk • Supabase (coming soon) • Auth0 (coming soon)
259+
Clerk • Supabase (coming soon) • Auth0 (AngularJS)
252260
```
253261

254-
## 🤝 Contributing
262+
## Contributing
255263

256264
We love contributions! Whether it's a bug report, feature request, or pull request — all are welcome.
257265

258-
259266
### Found a Bug?
260267

261268
Open an issue with:
@@ -267,34 +274,13 @@ Open an issue with:
267274

268275
---
269276

270-
## 📄 License
277+
## License
271278

272-
Distributed under the **MIT License**. See [`LICENSE`]<a href="https://github.com/YashVerma-code/hackpack/blob/main/LICENSE.md">LICENSE</a> for more information.
279+
Distributed under the **Proprietary License**. See <a href="https://github.com/YashVerma-code/hackpack/blob/main/LICENSE.md">LICENSE</a> for more information.
273280

274281
---
275282

276-
## 🙏 Acknowledgments
277-
278-
Made with ❤️ by TeamHackpack ( Varun & Yash ) — because setup time is coding time wasted 😜
279-
---
280-
281-
<div align="center">
283+
## Acknowledgments
282284

283-
### 🌟 If you find Hackpack useful, give it a star!
284-
285-
<p>
286-
<a href="https://github.com/YOUR_GITHUB_USERNAME/hackpack">
287-
<img src="https://img.shields.io/github/stars/YashVerma-code/hackpack?style=social" alt="Star on GitHub">
288-
</a>
289-
</p>
290-
291-
**Made with ❤️ to speed up your builds — one command at a time.**
292-
293-
<p>
294-
<!-- <a href="https://twitter.com/YOUR_TWITTER">Twitter</a>
295-
<a href="https://discord.gg/YOUR_DISCORD">Discord</a> • -->
296-
<a href="https://github.com/YashVerma-code/hackpack/issues">Issues</a>
297-
<a href="https://github.com/YashVerma-code/hackpack/discussions">Discussions</a>
298-
</p>
299-
300-
</div>
285+
By TeamHackpack ( Varun & Yash ) — because setup time is coding time wasted!
286+
<div>

0 commit comments

Comments
 (0)