This README is also availabe in Russian.
bem-core is a base library for web interface development.
It provides the minimal stack for coding client-side JavaScript and templating.
The easiest way to run a project with bem-core is to use
the project-stub.
You can use any other way you are familiar with to include the library into the project.
common.blocks— suited for any devices and browsersdesktop.blocks— should be used for desktop browserstouch.blocks— implement some touch-platforms specifics
i-bem— base block with helpers for JS and HTMLecma— some ES5 polyfilsstrings— helpers for JS-stringsobjects— helpers for JS-objectsfunctions— helpers for JS-functionsevents— JS-eventsquerystring— helpers for work with querystringtick— global timeridle— IDLE eventnext-tick— polyfill fornextTick/setTimeout(0, ...)inherit— OOP helpersjquery— jQueryclearfix— CSS clearfix trickidentify— identify JS-objectscookie— helpers for work with browser cookiesvow— Promises/A+ implementationdom— helpers for work with DOMloader— loader for JS filesua— browser features detectionpage— html/head/body scaffold
- vanilla.js + browser.js
- bemhtml
- bemtree
You can check the changelog at the changelog page.
If you used BEM before, check the migration instructions.
- Get the needed version code (e.g.,
v1):
$ git clone -b v1 [email protected]:bem/bem-core.git
$ cd bem-core
- Install the dependencies:
$ npm install
You need
export PATH=./node_modules/.bin:$PATH
or an alternative way to run locally-installed bem-tools.
- Install all the necessary libraries with bem-tools:
$ bem make libs
- Build examples and tests:
$ bem make sets
- Run development server:
$ bem server
- Create an issue with a proper description.
- Decide which version needs your changes.
- 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. - Commit changes and
push. Rebase your branch on a corresponding version branch if it's needed. - Create a pull-request from your feature branch; or several pull-requests if you changed several versions.
- Link your pull request with an issue number any way you like. A comment will work perfectly.
- Wait for your pull request and the issue to be closed ;-)
A default test bundle for ecma_array: bem make common.sets/ecma__array.tests/default
You can see the results of the tests 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.