Skip to content

Commit cbf15b9

Browse files
YashVerma-codeYashVerma-code
authored
Revise README for improved clarity and detail
Updated README to enhance project description, features, and usage instructions.
1 parent b9c183f commit cbf15b9

1 file changed

Lines changed: 245 additions & 24 deletions

File tree

‎README.md‎

Lines changed: 245 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,265 @@
1+
<div align="center">
2+
3+
# 🚀 Hackpack
4+
15
<p align="center">
26
<a href="https://github.com/YOUR_GITHUB_USERNAME/hackpack">
3-
<img src="https://readme-typing-svg.herokuapp.com?size=70&duration=2300&color=00FF00&center=true&vCenter=true&width=800&height=100&lines=Hackpack" alt="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">
48
</a>
59
</p>
610

7-
---
11+
<p align="center">
12+
<a href="https://www.npmjs.com/package/hackpack-cli"><img src="https://img.shields.io/npm/v/hackpack-cli?color=brightgreen&logo=npm" alt="npm version"></a>
13+
<a href="https://www.npmjs.com/package/hackpack-cli"><img src="https://img.shields.io/npm/dt/hackpack-cli?color=blue&logo=npm" alt="npm downloads"></a>
14+
<a href="https://github.com/YashVerma-code/hackpack/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Proprietary-red.svg" alt="License"></a>
15+
<a href="https://github.com/YashVerma-code/hackpack/stargazers"><img src="https://img.shields.io/github/stars/YashVerma-code/hackpack?style=social" alt="GitHub stars"></a>
16+
</p>
17+
18+
<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>
21+
</p>
822

923
<p align="center">
10-
<em>"Got tired of setting up projects? 🤯
11-
Want a one-step solution to kickstart your project faster and start coding without worrying about setup?
12-
Here is <b>Hackpack</b> 🚀"</em>
24+
<a href="#-quick-start"><strong>Quick Start</strong></a> •
25+
<a href="#-features"><strong>Features</strong></a> •
26+
<a href="#-cli-commands"><strong>CLI Commands</strong></a> •
27+
<a href="#-supported-stacks"><strong>Supported Stacks</strong></a> •
28+
<a href="#-roadmap"><strong>Roadmap</strong></a>
1329
</p>
1430

31+
</div>
32+
1533
---
1634

17-
## 🌟 Features
35+
## 🎯 What is Hackpack?
36+
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.
38+
39+
```bash
40+
npm i -g hackpack-cli
41+
```
1842

19-
- ⚡ **One-step setup** for your projects
20-
- 🛠 **Supports Next.js, Express, Node.js, Prisma, PostgreSQL, MongoDB, Tailwind** and more
21-
- 🧩 **Auto-generate boilerplate code** (frontend + backend)
22-
- 📂 **Pre-configured folder structure** for clean maintainable projects
23-
- 🔑 **Authentication setup support** (NextAuth, JWT)
24-
- 📦 **Package manager support** (npm, yarn, pnpm)
25-
- 🔧 **Customizable configurations** — choose what you need
26-
- 🖥 **CLI-based interface** with beautiful prompts
27-
- 🚀 **Saves hours** of repetitive setup so you can focus on building
43+
That's it. Your project is ready to go. 🎉
2844

2945
---
3046

31-
## 🚀 Getting Started
47+
## ✨ Features
48+
49+
<table align="center">
50+
<tr>
51+
<td>
52+
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.
61+
62+
</td>
63+
<td>
64+
65+
🗄️ **Database Ready**
66+
MongoDB, PostgreSQL support out of the box
67+
68+
🔐 **Auth Integration**
69+
Clerk authentication pre-configured
70+
71+
📦 **Package Manager Agnostic**
72+
Works with npm, yarn, or pnpm
73+
74+
</td>
75+
</tr>
76+
</table>
77+
78+
<div align="center">
79+
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
91+
92+
</div>
93+
94+
---
95+
96+
## 🚀 Quick Start
97+
98+
### Installation
99+
100+
```bash
101+
102+
# Install globally
103+
npm install -g hackpack
104+
105+
# Then run
106+
hp
107+
```
108+
109+
### Interactive Mode
110+
111+
Simply run the command and follow the prompts:
32112

33113
```bash
34-
# Clone the repo
35-
git clone https://github.com/YOUR_GITHUB_USERNAME/hackpack.git
114+
hp
115+
```
116+
117+
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
123+
124+
---
125+
126+
## 🧰 CLI Commands
127+
128+
### 📜 Core Commands
36129

37-
# Go inside the project
38-
cd hackpack
130+
| Command | Description |
131+
|---------|-------------|
132+
| `hp` | Launch interactive wizard (recommended for beginners) |
133+
| `hp -h`, `hp --help` | Display help and command usage |
134+
| `hp reset` | Clear all locally saved state and configurations |
135+
| `hp state` | View all saved projects and highlight the active one |
136+
| `hp resume` | Resume an interrupted or incomplete setup |
137+
| `hp run` | Execute setup for the currently selected project |
138+
139+
### 🔧 Project Management
140+
141+
| Command | Description |
142+
|---------|-------------|
143+
| `hp select <project-name>` | Set a project as active for operations |
144+
| `hp projects` | List all projects created with Hackpack |
145+
| `hp name <new-name>` | Rename the currently active project |
146+
| `hp add ui <library>` | Add a UI library to your project |
147+
| `hp uninstall ui <library>` | Remove an installed UI library |
148+
| `hp migrate` | 🔜 Migrate project to newer template versions |
149+
150+
### 💡 Usage Examples
151+
152+
```bash
153+
# Select and run a project
154+
hp select my-awesome-app
155+
hp run
39156

40-
# Install dependencies
41-
npm install
157+
# Add UI libraries on the fly
158+
hp add ui shadcn
159+
hp add ui daisyui
160+
161+
# Remove unwanted libraries
162+
hp uninstall ui tailwind
163+
164+
# Check your saved projects
165+
hp projects
166+
hp state
167+
```
168+
169+
### ⚡ Autocomplete Support
170+
171+
Speed up your workflow with terminal autocompletion:
172+
173+
| Command | Description |
174+
|---------|-------------|
175+
| `hp autocomplete install` | Show instructions for shell autocomplete (bash, zsh, fish) |
176+
| `hp autocomplete uninstall` | Remove autocomplete configuration |
177+
178+
```bash
179+
# Enable autocomplete
180+
hp autocomplete install
181+
182+
# Follow the instructions for your shell
183+
```
184+
185+
---
186+
187+
## 🎨 Supported Stacks
188+
189+
### Frontend Frameworks
190+
191+
```
192+
React (Vite) • Next.js • Astro • Vue • Nuxt • Angular
193+
```
194+
195+
### Backend Technologies
196+
197+
```
198+
Node.js • Express • Prisma • NestJS (coming soon) • FastAPI (coming soon)
199+
```
200+
201+
### UI Libraries
202+
203+
```
204+
shadcn/ui • DaisyUI • Material UI • Hero UI • Ant Design • Angular Material and many more...
205+
```
206+
207+
### Databases
208+
209+
```
210+
MongoDB • PostgreSQL (beta) • MySQL (coming soon) • SQLite (coming soon)
211+
```
212+
213+
### Authentication
214+
215+
```
216+
Clerk • Supabase (coming soon) • Auth0 (coming soon)
217+
```
218+
219+
## 🤝 Contributing
220+
221+
We love contributions! Whether it's a bug report, feature request, or pull request — all are welcome.
222+
223+
224+
### Found a Bug?
225+
226+
Open an issue with:
227+
- Clear description of the problem
228+
- Mail to [varun.singh10011@gmail.com] or [yashverma221004@gmail.com]
229+
- Steps to reproduce
230+
- Expected vs actual behavior
231+
- Your environment (OS, Node version, etc.)
232+
233+
---
234+
235+
## 📄 License
236+
237+
Distributed under the **MIT License**. See [`LICENSE`]<a href="https://github.com/YashVerma-code/hackpack/blob/main/LICENSE.md">LICENSE</a> for more information.
238+
239+
---
240+
241+
## 🙏 Acknowledgments
242+
243+
Made with ❤️ by Yash & Varun — because setup time is coding time wasted 😜
244+
---
245+
246+
<div align="center">
247+
248+
### 🌟 If you find Hackpack useful, give it a star!
249+
250+
<p>
251+
<a href="https://github.com/YOUR_GITHUB_USERNAME/hackpack">
252+
<img src="https://img.shields.io/github/stars/YashVerma-code/hackpack?style=social" alt="Star on GitHub">
253+
</a>
254+
</p>
255+
256+
**Made with ❤️ to speed up your builds — one command at a time.**
257+
258+
<p>
259+
<!-- <a href="https://twitter.com/YOUR_TWITTER">Twitter</a> •
260+
<a href="https://discord.gg/YOUR_DISCORD">Discord</a> • -->
261+
<a href="https://github.com/YashVerma-code/hackpack/issues">Issues</a> •
262+
<a href="https://github.com/YashVerma-code/hackpack/discussions">Discussions</a>
263+
</p>
42264
43-
# Run Hackpack CLI
44-
node index.js
265+
</div>

0 commit comments

Comments
 (0)