Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yunusga/kakadu
🚀 Модуль для локальных-тестовых изменений удалённого сайта (отладка скриптов, адаптация и т.п.)
https://github.com/yunusga/kakadu
local-tests pages proxy-server remote responsive site
Last synced: 21 days ago
JSON representation
🚀 Модуль для локальных-тестовых изменений удалённого сайта (отладка скриптов, адаптация и т.п.)
- Host: GitHub
- URL: https://github.com/yunusga/kakadu
- Owner: yunusga
- License: mit
- Created: 2016-08-01T10:41:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-09-29T06:25:11.000Z (about 2 years ago)
- Last Synced: 2024-10-04T17:44:23.571Z (about 1 month ago)
- Topics: local-tests, pages, proxy-server, remote, responsive, site
- Language: JavaScript
- Homepage:
- Size: 454 KB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kakadu
Модуль для локальных-тестовых изменений удалённого сайта (отладка скриптов, адаптация и т.п.)
## Содержание
- [Установка](#Установка)
- [Обновление](#Обновление)
- [Использование CLI](#Использование-cli)
- [Заготовка проекта](#Заготовка-проекта)
## Установка
- `git clone https://github.com/tazau/kakadu.git && cd kakadu && npm i . -g && npm link`
- возможны ошибки при установке `gulp-sass` на Windows OS, скорее всего потребуется установить `python 2`, в случае отстутствия установленного в системе python, gulp-sass не устанавливается. Не забудьте во время установки отметить пункт установки переменной окружения или добавить позже, вручную
## Обновление
При обновлении зависимостей `kakadu`, по причине плохого интернета или глюков в работе `npm` под **Windows**, может возникнуть ситуация что каких-то модулей вдруг станет нехватать.
###Костыль
После получения изменений из репозитория, необходимо удалить папку `node_modules` и выполнить `npm cache clean && npm i` (т.е. установить завосимости заново)
## Использование CLI
```javascript
$ kakadu --help
Usage: kakadu [options]
Options:
-V, --version показать версию модуля
-a, --auth [user@password] установка логина и пароля для авторизации
--proxy [url] URL для прокси
-p, --port порт для прокси
-t, --tech [tech] CSS пре-процессор styl, scss, less (по умолчанию styl)
-n, --nano включить cssnano
-c, --clipboard копировать URL прокси-сервера в буфер обмена
-o, --open открывать браузер при старте
-h, --help справка по использованию
```
### -a, --auth user@password
Устанавливает логин@пароль для включения авторизации для прокси (по умолчанию kakadu@случайный-пароль), в случае, если указать только имя пользователя, то, пароль сгенерируется автоматически.
### --proxy [url] -p, --port -t, --tech [tech]
Ипользуются вместе, в момент инициализации проекта, для установки значений в конфиге.
```
kakadu --proxy https://example.com -p 9000 -t styl
```
В случае если не прописать параметры в момент инициализации, придётся поправить всё вручную после создания проекта.
### --proxy [url]
URL проксируемого сайта проекта
### -p, --port
Установка порта для прокси. Имеет приоритет над установленным портом в конфиге (по умолчанию 8300).
### -t, --tech [tech]
CSS пре-процессор styl, scss, less (по умолчанию styl) для стилей проекта
### -n, --nano
Включает оптимизации и обжатие плагина cssnano
### -c, --clipboard
Открывает браузер при старте модуля,приоритет над опцией `open` для натстроек `browsersync`
Копировать URL прокси-сервера в буфер обмена
### -o, --open
Открывает браузер при старте модуля,приоритет над опцией `open` для натстроек `browsersync`
## Заготовка проекта
```bash
kakadu_project
├─ source
│ └─ components
| | ├─ template.{html,beml,php,etc}
| | ├─ template.{styl,less,scss}
| | └─ template.js
│ ├─ iconizer
│ │ ├─ icons
│ │ │ ├─ close.svg
│ │ │ └─ menu.svg
│ │ └─ sprite.svg
│ ├─ scripts
| | └─ app.js
│ └─ styles
| └─ app.{styl,less,scss}
│
└─ config.js
```