Miss any of our Open RFC calls?Watch the recordings here! »

balm-core

3.0.0-beta.17 • Public • Published
BalmJS

NPM version node Dependency Status Build Status Build 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.

Features

  • Based on gulp + webpack for any webapp projects
  • Automagically compile PostCSS/Sass/Less
  • CSS Autoprefixing
  • Automagically generation CSS sprites
  • enable ES2015+ features using Babel
  • Awesome images optimization
  • Built-in preview server with BrowserSync
  • Custom publish assets to remote (Front-end to Back-end) project
  • ZIP/FTP/PWA supported

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)
│ ├── fonts
│ ├── images
│ ├── media
│ ├─┬ scripts
│ │ └── index.js // Required. A entry file for JS.
│ ├─┬ styles
│ │ └── main.css // Required. A entry file for CSS.
│ └── index.html // Required. A entry file for HTML.
├── .dotfile     // (e.g. .gitignore, .browserslistrc, etc...)
├── babel.config.js
├── balm.config.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-core NPM version 🃏 BalmJS core (for balm@3)
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
balm-scroll NPM version 📜 Smooth scrolling 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 12.0.0 and npm 5.2.0 by running node -v and npm -v in a terminal/console window. Older versions maybe produce errors, but newer versions are fine.

You develop apps in the context of an Balm workspace.

To create a new workspace and initial starter app:

# /path/to/YOUR_WORKSPACE 
mkdir -p balm-project/src/{styles,scripts}
cd balm-project
npm init -y

1. Installing balm

yarn global add balm-core
yarn add -D balm@3
# OR 
npm install -g balm-core
npm install -D balm@3

We currently recommend using Yarn instead of npm.

2. Configuration

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

module.exports = {
  // Your project config
};

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

3. Usage

Edit package.json in your project directory:

{
  "scripts": {
    "dev": "balm",
    "prod": "balm -p"
  }
}

Run the command in your project directory:

# For development 
npm run dev
 
# For production 
npm run prod

Documentation

License

MIT

© 2016-present, Elf-mousE

Special Thanks to

In chronological order

Install

npm i balm-core

DownloadsWeekly Downloads

238

Version

3.0.0-beta.17

License

MIT

Unpacked Size

414 kB

Total Files

204

Homepage

balm.js.org

Last publish

Collaborators

  • avatar