# 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

NOTE: balm < 3 using gulp for the build process, so you need install gulp-cli globally and gulp local dependency.

# 1. Installing

yarn global add balm-core
yarn add -D b[email protected]

OR

npm install -g balm-core
npm install -D [email protected]

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:

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

Run the command in your project directory:

# For development
npm run dev

# For production
npm run prod
Last Updated: 17 hours ago