BEM Core Library

This README is also availabe in Russan.

What is it?

bem-core is a base library for web interfaces development. It provides the minimal stack for coding client-side JavaScript and templating.

Use

The easiest way to run a project with bem-core is to use the project-stub.

You can also include the library into your project with another way which you are used to use.

Inside

Levels

• common.blocks
• desktop.blocks
• touch.blocks

Blocks

• i-bem

Technologies

• bemhtml
• bemtree

Changelog

You can check the changelog at the changelog page.

Migration

If you used BEM before, check the migration instruction.

Development

Working copy

1. Get the needed version code (e.g., v1):

$ git clone -b v1 [email protected]:bem/bem-core.git
$ cd bem-core

2. Install teh dependencies:

$ npm install

You need export PATH=./node_modules/.bin:$PATH or an alternative way to run locally-installed bem-tools.

3. Install all the necessary libraries with bem-tools:

$ bem make libs

4. Build examples and tests:

$ bem make sets

5. Run development server:

$ bem server

How to contribute

1. Create an issue with a proper description.
2. Decide which version needs your changes.
3. Create a feature-branch with an issue number and a version (issues/<issue number>@v<version number>) based on a version branch. For example, for an issue #42 and a version #1: git checkout -b issues/42@v1 v1. If you need changes for several versions, each of them has to have a feature branch.
4. Commit changes and push. Rebase your branch on a corresponding version branch if it is needed.
5. Create a pull-request from your feature branch; or several pull-requests if you changed for several versions.
6. Link your pull request with an issue any way you like. A comment will work perfectly.
7. Wait your pull request and the issue to be closed ;-)

Modular testing

A default test bundle for ecma_array: bem make common.sets/ecma__array.tests/default You can see the results of the test in the terminal after the building process finishes. You can also watch them in a browser loading common.sets/ecma__array.tests/default/default.html.

Run tests for other BEM entities in the same way. This will work for those which are equiped with .test.js file.

Test are built with a bem-pr library. Check the [details](https://github.com/narqo/bem-pr/blob/master/docs/tests.ru.md] about testing infrastructure of the bem-pr library.