Skip to content

Commit 942aea5

Browse files
updated README
1 parent baaa7b8 commit 942aea5

4 files changed

Lines changed: 18 additions & 6 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
<a href="#quick-start"><strong>Quick Start</strong></a> •
2525
<a href="#features"><strong>Features</strong></a> •
2626
<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>
27+
<a href="#supported-stacks"><strong>Supported Stacks</strong></a>
28+
<!-- <a href="#roadmap"><strong>Roadmap</strong></a> -->
2929
</p>
3030

3131
</div>
@@ -238,6 +238,16 @@ The state is stored in a hidden `.hackpack-state.json` file (in your project fol
238238

239239
Each project you create gets its own state and can be resumed or configured independently!
240240

241+
## How to use database in your project
242+
243+
Hackpack automatically configures a **MongoDB backend** for your project, tailored to the selected framework (Next.js, Astro, SvelteKit, Nuxt, or Node.js backend).
244+
Once you choose a database option (like MongoDB), Hackpack generates all the necessary folders, files, and environment variables required.
245+
246+
Once setup is done, you only need to:
247+
- Create your models inside the generated `/models` directory.
248+
- Call the `ConnectToDB()` function (auto-generated in the project) to establish a connection whenever your app starts.
249+
- Hackpack ensures your app connects to MongoDB instantly without manual configuration.
250+
241251
### Commands That Use State
242252

243253
| Command | Purpose |

lib/commands/projectSetup.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ export async function runSetupFromState(state) {
8787
await setupAuth0(state);
8888
break;
8989
case 'lucia':
90+
// To be done
9091
await setupLuciaAuth(state);
9192
break;
9293
default:

lib/interactive/wizard.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -563,7 +563,7 @@ async function askDatabase() {
563563
try {
564564
const choices = [
565565
// { name: 'SQLite', value: 'sqlite' },
566-
{ name: 'PostgreSQL', value: 'postgresql' },
566+
{ name: 'PostgreSQL (beta)', value: 'postgresql' },
567567
// { name: 'MySQL', value: 'mysql' },
568568
{ name: 'MongoDB', value: 'mongodb' },
569569
{ name: 'None', value: null },
@@ -592,8 +592,8 @@ async function askAuthentication() {
592592
try {
593593
const choices = [
594594
{ name: 'Clerk', value: 'clerk' },
595-
{ name: 'Auth.js', value: 'authjs' },
596-
{ name: 'Lucia', value: 'lucia' },
595+
{ name: 'Auth.js (Next only)', value: 'authjs' },
596+
// { name: 'Lucia', value: 'lucia' },
597597
{ name: 'Auth0 (Angular only)', value: 'authzero' },
598598
{ name: 'None', value: null },
599599
new inquirer.Separator(),

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
"url": "git+https://github.com/YashVerma-code/hackpack.git"
2020
},
2121
"keywords": [
22-
"cli"
22+
"cmd","command","cli","hackpack","hackathon","terminal","console","argument",
23+
"util","utility","build","bash","enquirer","generate","nextjs","react","angular","Vue","typescript","mongodb","postgres","Svelte","nuxt"
2324
],
2425
"author": "yash aur varun",
2526
"license": "Proprietary",

0 commit comments

Comments
 (0)