https://github.com/siaexplains/beshkan
application builder
https://github.com/siaexplains/beshkan
Last synced: 9 months ago
JSON representation
application builder
- Host: GitHub
- URL: https://github.com/siaexplains/beshkan
- Owner: SiaExplains
- Created: 2025-03-29T10:55:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-22T07:10:44.000Z (about 1 year ago)
- Last Synced: 2025-10-09T08:05:24.620Z (9 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Beshkan CLI
🚀 A simple CLI tool to bootstrap a full-stack web application using the [Beshkan App Template](https://github.com/SiaExplains/app-template).
This CLI clones a starter frontend project built with **Next.js** and **TypeScript**, unlinks the Git history, sets up custom metadata like app name and description, and gets you ready to launch your own full-stack application.
---
## ✨ Features
- 🧱 Clones the Beshkan `app-template` repo
- 🧼 Unlinks Git history from the cloned repo
- 💠 Prompts for custom project title and description (or skip via `--default`)
- 📝 Replaces placeholders in the frontend layout file
- 🔧 Sets up the project directory cleanly for your own use
---
## 📆 Installation
```bash
npm install -g beshkan
```
---
## ⚙️ Usage
```bash
beshkan --name my-app
```
This will:
1. Clone the `app-template` into a folder called `my-app`
2. Ask you for the **project title** and **description**
3. Replace placeholders like `<<>>` and `<<>>` in your layout file
4. Unlink the `.git` history so you can start fresh
### Optional Flags
| Flag | Description |
|--------------|-----------------------------------------|
| `--name` | **(Required)** Your project directory name |
| `--default` | Use default values for title & description |
---
## 🧪 Example
```bash
beshkan --name portfolio
```
```bash
beshkan --name blog --default
```
---
## 🧹 Template Used
This CLI pulls from:
👉 [https://github.com/SiaExplains/app-template](https://github.com/SiaExplains/app-template)
More templates (backend, database, etc.) coming soon!
---
## 📜 License
MIT
---
## 💬 About
Beshkan CLI is part of the **Beshkan** project – a full-stack site builder that simplifies bootstrapping modern web apps with **Next.js**, **NestJS**, **Express**, **TypeScript**, and more.
Made with ❤️ by [@SiaExplains](https://github.com/SiaExplains)