Installation

0. Requirements

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

Install Node.js® and npm (opens new window) if they are not already on your machine.

Verify that you are running at least node 18.12.0 by running node -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 my-project/src/{styles,scripts}
echo "Hello World" > my-project/src/index.html

cd my-project
npm init -y

1. Installing balm

⚠️ legacy version for node >= 10.13.0

# v4
npm install -g balm-core
npm install -D balm

# v3
npm install -g balm-core@legacy
npm install -D balm@legacy

OR

# v4
yarn global add balm-core
yarn add -D balm

# v3
yarn global add balm-core@legacy
yarn add -D balm@legacy

We currently recommend using Yarn (opens new window) 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