Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balmjs/balm-cli
:spades: BalmJS scaffolding tool for modern webapps
https://github.com/balmjs/balm-cli
balm generator javascript nodejs scaffolding templates
Last synced: about 1 month ago
JSON representation
:spades: BalmJS scaffolding tool for modern webapps
- Host: GitHub
- URL: https://github.com/balmjs/balm-cli
- Owner: balmjs
- License: mit
- Created: 2016-07-03T22:23:25.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-13T07:57:09.000Z (about 2 months ago)
- Last Synced: 2024-11-21T14:15:58.515Z (about 2 months ago)
- Topics: balm, generator, javascript, nodejs, scaffolding, templates
- Language: JavaScript
- Homepage:
- Size: 591 KB
- Stars: 9
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Balm CLI [![NPM version][balm-cli-image]][balm-cli-url]
A simple CLI for scaffolding [BalmJS](https://github.com/balmjs/balm) projects.
## Requirements
> ⚠️ NOTE: `balm-cli` >= 4.4.0 requires Node >= 18, `balm-cli` = 4.3.0 requires Node >= 16, `balm-cli` <= 4.2.0 requires Node >= 14.17.0
1. [Node.js](https://nodejs.org/)
2. [Git](https://git-scm.com/)
3. [BalmJS](https://balm.js.org/) `balm-core` >= 3
First install the `balm-core` globally.
```sh
npm install -g balm-core
# OR
yarn global add balm-core
```
## Installation
Then install the `balm-cli` globally.
```sh
npm install -g balm-cli
# OR
yarn global add balm-cli
# Verify
balm -V
# Output:
# balm-cli: 4.0.0
# balm-core: 4.0.0 (Global)
```
> ⚠️ NOTE: For Windows users, use `balm-cli@legacy`
## Usage
```sh
# See all available official templates
balm list
```
```sh
balm init
```
Example:
```sh
# Official template
balm init vue-ui my-project
```
```sh
# Custom template
balm init username/repo my-project
```
## Official Templates
- Default
- [simple](https://github.com/balmjs/template-simple) - A simple project
- Vue.js
- [vue](https://github.com/balmjs/template-vue) - A Vue.js project
- [vue-expert](https://github.com/balmjs/template-vue-expert) - A Vue.js project with router
- [vue-master](https://github.com/balmjs/template-vue-master) - A Vue.js project with router & store
- [vue-ui](https://github.com/balmjs/template-vue-ui) - A Vue.js project with router & BalmUI
- [vite](https://github.com/balmjs/template-vite) - A Vue.js project with Vite & BalmUI (Recommended)
- [vue-ssr](https://github.com/balmjs/template-vue-ssr) - A server-rendered Vue.js project (Experimental)
- [vue-ssr-without-vuex](https://github.com/balmjs/template-vue-ssr-without-vuex) - A server-rendered Vue.js project without Vuex (Experimental)
- [vue-wechat-mp](https://github.com/balmjs/template-vue-wechat-mp) - 使用 Vue 同构微信小程序和 Web
- React
- [react](https://github.com/balmjs/template-react) - A React project
- [react-expert](https://github.com/balmjs/template-react-expert) - A React project with router
- [react-master](https://github.com/balmjs/template-react-master) - A React project with router & store
- Angular
- [ng](https://github.com/balmjs/template-ng) - An Angular project
- Desktop apps
- [electron](https://github.com/balmjs/template-electron) - An Electron project
- [tauri](https://github.com/balmjs/template-tauri) - A Tauri project (Coming soon)
- Others
- [pwa](https://github.com/balmjs/template-pwa) - Progressive Web Apps project
- [legacy](https://github.com/balmjs/template-legacy) - A jQuery project for older browsers
- [svelte](https://github.com/balmjs/template-svelte) - A Svelte project
- [solid](https://github.com/balmjs/template-solid) - A Solid project
[balm-cli-image]: https://img.shields.io/npm/v/balm-cli
[balm-cli-url]: https://www.npmjs.com/package/balm-cli