GH App Boilerplate & CLI

This repository contains a professional-grade boilerplate for building web applications with a NestJS backend and Next.js frontend, along with a CLI tool to bootstrap new projects.

🚀 Key Features

• One-Step Registration: Simplified auth flow (Register -> Dashboard).
• Unified Profile: A single, clean profile model for all users.
• Core Modules: Auth, Chat, Payment, Profile, Notification, and Upload.
• CLI Tool: Bootstrap new projects with custom folder names via npx create-gh-app.

📦 Publishing to NPM

To use this like npx create-next-app, you need to publish it to the NPM registry.

1. Login to NPM:

   npm login

2. Publish the Package: From the boilerplate/ directory, run:

   npm publish

   Note: Make sure the name in package.json is unique (e.g., create-gh-app or your chosen name).

🛠️ Usage with npx

Once published, you can start a new project from anywhere:

npx create-gh-app

The CLI will prompt you for:

• Project Name (e.g., my-cool-app)
• Backend Folder Name (default: gh-be)
• Frontend Folder Name (default: gh-fe)

It will then:

1. Create the project directory.
2. Copy the templates into your custom-named folders.
3. Update package.json with the new project name.
4. Initialize a git repository.

🏗️ Local Development & Testing

If you want to test the CLI locally without publishing:

1. Link the package:

   cd boilerplate
   npm link

2. Run the CLI:

   create-gh-app

⚙️ Project Setup (After Bootstrapping)

Each project folder (backend/frontend) comes with its own .env.example.

Backend:

1. cd <backend-folder>
2. npm install
3. cp .env.example .env
4. npx prisma db push
5. npm run start:dev

Frontend:

1. cd <frontend-folder>
2. npm install
3. cp .env.example .env
4. npm run dev

📄 License

MIT