Skip to content

Commit

Permalink
Create build.md
Browse files Browse the repository at this point in the history
  • Loading branch information
1aerostorm committed May 11, 2024
1 parent eda2428 commit f54de8f
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions golos-lib-js/docs/files/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Сборка своей собственной golos-lib-js

Вы можете собрать свою собственную копию golos-lib-js, чтобы дополнительно проаудировать ее, или, к примеру, доработать для использования в специфических проектах\задачах.

1. Установите [Node 16+](https://nodejs.org/en/download).

2. Установите yarn:
```js
npm install -g yarn
```js
Если вы не можете выполнить эту команду, но Node.js установлен, то нужно в переменную PATH добавить путь к `node` и `npm`.
3. Скачайте golos-lib-js нужной версии (`master` - последняя стабильная версия):
```sh
git clone https://github.com/golos-blockchain/libs -b master
```
Если вы не можете выполнить эту команду, установите [Git](https://git-scm.com/).

4. Соберите golos-lib-js:
```js
yarn install
yarn run build
```

5. Если сборка успешна, вы можете проверить корректность сборки с помощью тестов:
```js
yarn run test
```
Если ошибок нет, то вероятно сборка прошла без проблем.

6. При локальной работе со своим проектом вы можете добавлять библиотеку в проект следующим образом:
```js
yarn add /root/libs/golos-lib-js
```
или
```js
npm install /root/libs/golos-lib-js
```
где `/root/libs/golos-lib-js` - полный путь к библиотеке, **собранной** согласно пункту 4.

0 comments on commit f54de8f

Please sign in to comment.