Nonflavored Prescription Medicine
Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

balm

0.24.8 • Public • Published
BalmJS

NPM version Build Status Build Status Dependency Status Coverage percentage

BalmJS

A flexible Front-End workflow for webapps

What's BalmJS?

BalmJS prescribes best practices and tools to help you stay productive.

Structure

Returning to webapp's original nature.

project
├── .tmp         // Scaffolds out a temporary directory for development
├── dist         // Scaffolds out the production build
├─┬ src          // Source code in here (Create a directory in project)
│ ├─┬ styles
│ │ └── main.css // Required. A entry file for CSS.
│ ├─┬ scripts
│ │ └── main.js  // Required. A entry file for JS.
│ ├── images
│ ├── fonts
│ ├── media
│ └── index.html // Required. A entry file for HTML.
├─┬ config       // Optional. But recommended. Refer to BalmCLI's templates.
│ ├── balmrc.js
│ └── publish.js
├── .dotfile     // (.babelrc, .gitignore, etc...)
├── gulpfile.js  // Required. A configuration file for Balm.
├── package.json // Required.
└── ...

⚡️ We recommend using Balm CLI to scaffold out a front-end web app. 👻

Ecosystem

Project Status Description
balm-cli NPM version ♠️ BalmJS scaffolding tool
balm-gui N/A ♣️ GUI for BalmJS
balm-ui-lite NPM version ♥️ Material Design Lite + Vue
balm-ui NPM version ♦️ Next Generation Material UI for Vue.js

Demo

Installation

0. Requirements

You need to set up your development environment before you can do anything.

Install Node.js® and npm if they are not already on your machine.

Verify that you are running at least node 8.x.x and npm 5.x.x by running node -v and npm -v in a terminal/console window. Older versions maybe produce errors, but newer versions are fine.

BalmJS workflow using gulp for the build process, so you need install gulp-cli.

$ npm install --global gulp-cli
 
# Verify 
$ gulp -v

1. Installing balm

Install with npm:

# babel 7.x 
$ npm install --save-dev gulp balm
 
# babel 6.x 
$ npm install --save-dev gulp balm@0.23

Install with yarn:

# babel 7.x 
$ yarn add --dev gulp balm
 
# babel 6.x 
$ yarn add --dev gulp balm@0.23

2. Configuration

In your project directory, create a file named gulpfile.js in your project root with these contents:

// 1. import balm
var balm = require('balm');
 
// 2. config balm
balm.config = {
  // your project config
};
 
// 3. run balm
balm.go();

📃 Refer to our configuration docs to learn more about config balm.

3. Usage

Run the gulp command in your project directory:

# for development 
$ gulp
 
# for production 
$ gulp --production

Documentation | 中文文档

License

MIT

© 2016-present, Elf-mousE

Thanks to

In chronological order

install

npm i balm

Downloadsweekly downloads

179

version

0.24.8

license

MIT

homepage

balmjs.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability