Skip to content

Up readme #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
silrage wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Up readme #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
/node_modules
# IDE, System
.DS_Store
.idea
.vscode

# Packages
node_modules/
npm-debug.log
package-lock.json

# Auto-generated
/process
/store
/store

# Dump
/work
44 changes: 33 additions & 11 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
Утилита предназначена для создания локальных бекапов fig файлов
## Figma backup
<i>Утилита для создания локальных бекапов fig файлов</i>
<hr>

Для работы необходимо:
## Для работы понадобятся:
1. bash консоль
2. Установленная node (проверено на версии v16.13.0)
3. Для полной версии, установленный python (проверено на Python 2.7.18)
2. Установленная NodeJS (проверено на версии v16.13.0)
3. Для Full запуска, установленный python (проверено на Python 2.7.18)

Ligth запуск
## Режимы запуска:

### Light запуск

Предусмотрен вариант запуска в режиме простого скачивания.
Для этого необходимо в корне проекта
1. Установить зависимости node (команда `npm i`)
2. Выполнить команду `node download_figma_files.js figmaLogin=<ваш логин> figmaPassword=<ваш пароль> figmaUrl=<полный адрес файла, который необходимо скачать>`
2. Выполнить команду:
```
node download_figma_files.js
figmaLogin=<ваш логин>
figmaPassword=<ваш пароль>
figmaUrl=<полный адрес файла, который необходимо скачать>
```

В случае если необходимо скачать несколько файлов, можно подготовить конфигурационный json файл следующего формата:
`[
{
Expand All @@ -25,18 +36,29 @@ Ligth запуск
"team": "<название команды>"
}
]`
Загрузка файлов по конфигурационному файлу осуществляется командой `node download_figma_files.js figmaLogin=<ваш логин> figmaPassword=<ваш пароль> igmaFilesList=<путь до файла>`
Загрузка файлов по конфигурационному файлу осуществляется командой:
```
node download_figma_files.js
figmaLogin=<ваш логин>
figmaPassword=<ваш пароль>
figmaFilesList=<путь до файла>
```

В ligth запуске все файлы будут сохранены в директорию `./process/_download`. Если эта директория не пустая, существующие в ней файлы будут переименованы
В Light запуске все файлы будут сохранены в директорию `./process/_download`. Если эта директория не пустая, существующие в ней файлы будут переименованы

<br>

Full запуск
### Full запуск (Python)

Требует установленного python, отличается от ligth версии следующим:
Требует установленного python, отличается от Light версии следующим:
1. Скачивает все файлы для команд, указанных в `./config/get_figme_files_list.yml`
2. Анализирует время изменения файла в figma и если файл не менялся с прошлого запуска пропускает их

Для запуска полной версии необходимо выполнить команду `./manage.sh <ваш логин> <ваш пароль>`.
Для запуска полной версии необходимо выполнить команду:
```
./manage.sh <ваш логин> <ваш пароль>
```

Файлы будут сохранены в `./store`, если какие-то файлы были обновлены, предыдущие версии сохраняются в `./store/<дата запуска>`

Настройки:
Expand Down