README.md

Это версия с длительным сроком поддержки (LTS). Выходить отныне будут только минорные обновление (багфиксы, хотфиксы и прочие фиксы). Все основные силы сейчас брошены на разработку Kalium19 v4.

Чт, 18 авг.: Поддержка Kalium19 v3 окончена! Переходите на актуальную версию Kalium19

---

Kalium19 v3

📦 Набор утилит, миксинов, расширений на языке препроцессора SASS для помощи в ускорении и упрощении написания CSS-стилей.

📥 Начало работы

Для установки Kalium19 в проект будет хорошо использовать пакетный менеджер от NodeJS - npm.

Установка через npm

Откройте терминал в папке проекта и выполните команду

npm install @rx1310/kalium19

После в основном SASS/SCSS-файле стилей в начале пропишите импорт модуля через директиву @use:

@use 'node_modules/@rx1310/kalium19' as k19;

• node_modules/ - это папка, куда скачались файлы Kalium19
• k19 - это название пространства имен (можно указать *)

Пример из реального проекта:

@use '../node_modules/@rx1310/kalium19' as k19 with (
  $border-radius: .8em,
  $bem-element: '__',
  $bem-modifier: '--',
  $opacity-ie5: false,
  $keyframes-o: false
);

Клонирование репозитория

git clone https://github.com/91muilak/kalium19.v3

Клонирование в качестве субмодуля

Также можно склонировать проект в качестве Git Submodule с GitHub используя команду:

git submodule add https://github.com/91muilak/kalium19.v3

Для клонирования проекта необходимо иметь установленный git. Если он установлен, то просто выполните команду git clone в терминале.

Загрузка архива репозитория

Если у Вас нет желания работать с npm, то Вы можете со страницы репозитория скачать архив репозитория.

Если у Вас установлен curl или Wget, то можете воспользоваться командой в терминале:

# curl
curl -L -O https://github.com/91muilak/kalium19.v3/archive/refs/heads/main.zip

# wget
wget --no-check-certificate --content-disposition https://github.com/91muilak/kalium19.v3/archive/refs/heads/main.zip

👨‍💻 Разработка

Чтобы самому начать разработку Kalium19 локально необходимо:

1. Склонировать репозиторий на Ваш компьютер,

2. Открыть папку проекта в терминале,

   cd kalium19

3. Установить все зависимости проекта,

   npm install

4. Готово!

Сборка

В файле package.json уже прописаны скрипты для компиляции для тестирования.

На самом деле сам по себе Kalium19 в стили ничего не добавляет. Поэтому, если Вы скомпилируете index.scss, то в CSS ничего не будет.

Для разработки я использую команду npm run sass:watch, которая компилирует SASS сразу при изменениях. Эта команда собирает только один файл — test.scss (его нет в репо т.к. он в исключении .gitignore).

Лицензия

Проект Kalium19 распространяется совершенно бесплатно и находится под защитой лицензии MIT.

Инструментарий, используемый в разработке, распространяется по указанной автором / компанией / разработчиком лицензии, не зависящей от этого проекта!

MIT License
Copyright (c) 2022, Haba Kudzaev (rx1310) <[email protected]>

Если Вы нашли нарушение чьей-либо лицензии в моем проекте, то просьба написать мне → Telegram, эл. почта или VK.