LECTRUM/generator-ui

⚡️Генератор проекта с самыми современными технологиями

Генератор UI-проекта от Lectrum

👋🏼 Привет и добро пожаловать!

🚀 Этот репозиторий содержит исходный код генератора UI-проекта. Мы постоянно обновляем генератор самыми вкусными фичами.

🛰 Данная инструкция содержит информацию по использованию генератора.

Что такое генератор проекта?

Генератор проекта — это программа-помощник. Генератор помогает поддерживать состояние проекта в хорошей форме.
Это достигается путём вынесения настроек среды разработки в единое место. Например — этот репозиторий.

Как генератор поможет мне?

С его помощью можно развернуть новый проект

Установи yeoman и генератор проекта Lectrum:

npm i -g yo
npm i -g @lectrum/generator-ui

Создай пустую директорию для нового проекта и перейди в неё:

mkdir new-project
cd new-project

И выполни следующую команду:

yo @lectrum/ui

✅ Генератор развернёт новый проект и установит все зависимости.

Генератор умеет обновлять уже развёрнутый проект

Мы любим держать среду разработки в хорошем состоянии, поэтому постоянно улучшаем её. Чтобы обновить среду разработки сперва нужно обновить генератор проекта:

npm i -g @lectrum/generator-ui

Обновив генератор до последней версии можно обновить окружение выполнив команду:

yo @lectrum/ui

Yeoman попросит подтвердить обновление устаревших файлов. Нужно согласится. Когда Yeoman закончит обновление файлов нужно обновить зависимости:

yarn

или

npm i

✅ Теперь среда разработки обновлена до последней версии и можно приступать к кодингу.

🤖 Краткий обзор команд для сгенерированного проекта

Заметка: эти команды станут доступны после первого выполнения команды yo @lectrum/ui.
Запускать через yarn «имя команды» или npm run «имя команды».

Команда	Описание
start	запустить проект для разработки
build	запустить сборку проекта
checkpoint	синхронизировать проект с версией проекта преподавателя (обсуждается с преподавателем)
build:analyze	запустить сборку проекта и запустить режим детального анализа результата сборки
lint:javascript	провести анализ исходного JavaScript-кода на стилистические ошибки
lint:css	провести анализ исходного CSS-кода на стилистические ошибки
lint	провести анализ всего исходного кода на стилистические ошибки
test	запустить тесты
test:watch	запустить тесты в watch-режиме
test:debug	запустить тесты в debug-режиме
soundcheck	запустить все линтеры и тесты
prettier	отформатировать исходный код с помощью prettier

Заметка: после деплоя на Github Pages приложение будет доступно по адресу:
https://имя-твоего-пользователя-гитхаб.github.io/имя-твоего-репозитория-с-приложением

Что нужно знать о Yeoman

• 🌟 Сердце Yeoman сделано из чистого золота.
• 🙏🏼 Yeoman — персонаж чуткий и нравственный, но работать с ним легко и приятно.
• 👩🏼‍🎓 Подробнее Yeoman можно изучить на официальном сайте.

🤔 FAQ

Ответы на часто задаваемые вопросы можно найти здесь.

Лицензия

MIT © Lectrum