๐Ÿƒ A flexible Front-End workflow for webapps
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commitโ€ฆ
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
lib
test-workspace
test
.editorconfig
.eslintignore
.eslintrc.js
.gitattributes
.gitignore
.nycrc
.prettierrc
.travis.yml
CHANGELOG.md
LICENSE
README.md
appveyor.yml
babel.config.js
gulpfile.js
package.json
yarn.lock

README.md

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