Skip to content

Commit

Permalink
#50 translated root folder readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sharovatov committed Jan 13, 2024
1 parent 9b9bdba commit 717bdde
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,25 @@ A system for animal shelters, providing an easy and free way for shelter owners
- [meta page](https://meta.shelterpaws.org)
- [website](https://shelterpaws.org)

## Режим разработки
## Preparing the dev mode

Перед тем, как закоммитить изменения, необходимо установить зависимости:
Before committing changes, it is necessary to install dependencies:

```
npx husky-init && yarn install
```

### Возможные проблемы
### Possible Issues

#### Found incompatible module.

Для успешной установки всех зависимостей желательно использовать **node >=18.12.0**. Для переключения между версиями node можно воспользоваться [nvm](https://github.com/nvm-sh/nvm).
We support **node >=18.12.0**. To switch between node versions, use [nvm](https://github.com/nvm-sh/nvm).

#### fatal: cannot exec '.husky/pre-commit': No such file or directory

1. Скопировать содержимое файла `.husky/pre-commit`:
1. Remove `.husky/pre-commit` file

2. Create empty `.husky/pre-commit` and paste the following code into the file:

```
#!/bin/sh
Expand All @@ -30,21 +32,17 @@ npx husky-init && yarn install
yarn precommit
```

2. Удалить файл `.husky/pre-commit`

3. Создать пустой `.husky/pre-commit` и вставить туда скопированный код.

4. Запустить команду `npx husky install`
3. Run `npx husky install`

5. Попробовать еще раз сделать коммит.
5. Try committing once again.

Если данная инструкция не решила проблему, можно обойти проверку, используя флаг `--no-verify`:
If this instruction did not solve the problem, you can bypass the check using the `--no-verify` flag:

```
git commit -m 'commit name' --no-verify
```

Перед тем, как закоммитить изменения с флагом `--no-verify`, рекомендуется запустить проверки вручную и исправить ошибки, если они есть:
Before committing changes with the `--no-verify` flag, it is recommended to run checks manually and fix errors if there are any:"

```
yarn stylelint
Expand Down
51 changes: 51 additions & 0 deletions README_ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# shelterpaws
A system for animal shelters, providing an easy and free way for shelter owners to display their pets, help them find new homes, and fundraise.

- [board to work on](https://github.com/orgs/qase-tms/projects/5/views/1)
- [meta page](https://meta.shelterpaws.org)
- [website](https://shelterpaws.org)

## Режим разработки

Перед тем, как закоммитить изменения, необходимо установить зависимости:

```
npx husky-init && yarn install
```

### Возможные проблемы

#### Found incompatible module.

Для успешной установки всех зависимостей желательно использовать **node >=18.12.0**. Для переключения между версиями node можно воспользоваться [nvm](https://github.com/nvm-sh/nvm).

#### fatal: cannot exec '.husky/pre-commit': No such file or directory

1. Скопировать содержимое файла `.husky/pre-commit`:

```
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
yarn precommit
```

2. Удалить файл `.husky/pre-commit`

3. Создать пустой `.husky/pre-commit` и вставить туда скопированный код.

4. Запустить команду `npx husky install`

5. Попробовать еще раз сделать коммит.

Если данная инструкция не решила проблему, можно обойти проверку, используя флаг `--no-verify`:

```
git commit -m 'commit name' --no-verify
```

Перед тем, как закоммитить изменения с флагом `--no-verify`, рекомендуется запустить проверки вручную и исправить ошибки, если они есть:

```
yarn stylelint
```

0 comments on commit 717bdde

Please sign in to comment.