design system starter

Система проектирования правительства Австралии была выведена из эксплуатации. Посетите нашу страницу сообщества для получения дополнительной информации

Австралийская система проектирования правительства - стартер

Начните с полными шаблонами страниц, используя систему проектирования правительства Австралии.

Содержимое

• Шаблоны
• Среда развития
• Начните
• Как это работает
• Предварительные условия
• Внося
• Лицензия

---

Шаблоны

Просмотрите полные шаблоны страниц, используя систему проектирования правительства Австралии.

• Домашняя страница
• Страница контента
• Форма страница

Среда развития

Клонировать этот репозиторий, чтобы создать локальную среду разработки и начать изменение шаблонов.

• Начните
• Как это работает
• Внося
• Лицензия

---

Начните

Стартовый пакет использует NPM (Manager пакета узлов) для настройки локальной среды разработки и установки компонентов системы проектирования. Диспетчер пакетов по умолчанию для узла - NPM. Когда вы загружаете узел, NPM предварительно установлен.

1. Убедитесь, что на компьютере установлены NPM и узлы. Вы можете следовать инструкциям NPM, если не уверены.

2. Скачать, клонировать или разобрать этот репозиторий в папку на вашем компьютере.

3. В командной строке перейдите в эту папку и запустите npm install . Это установит зависимости, необходимые для местной среды разработки.

4. Теперь вы должны быть готовы запустить локальный сервер, запустив npm run watch . Это будет следить за изменениями в *.scss *.css

Использование Docker

Создайте изображение:

$ docker build -t ds-starter .

Затем запустите изображение и сопоставьте громкость. Примечание: $ PWD не поддерживается в Windows.

$ docker run --rm --volume= " $PWD :/app " -p 3000:3000 -it ds-starter

⬆ Вернуться к вершине

---

Как это работает

В вашем каталоге у вас есть файл package.json . Этот файл указывает на зависимости для установки при запуске npm install . Когда вы запускаете npm install вы установите все компоненты системы проектирования и дополнительные пакеты, связанные с местной средой разработки.

После того, как npm install блины, это проверяет, что ваши зависимости работают вместе, и создает docs/js/script.min.js и src/sass/_uikit.scss .

src/sass/main.scss импортирует сгенерированные _uikit.scss . Вы не должны касаться файла _uikit.scss по мере его создания, но не стесняйтесь менять файл main.scss .

Когда пользователь запускает npm run build или npm run watch мы используем Node-Sass для преобразования файла src/sass/main.scss в файл docs/css/main.css . AutoPrefixer запускается после компиляции, чтобы добавить префиксы поставщиков в файл main.css .

Обратитесь к сценариям package.json для того, как это было настроено

Эта настройка позволяет изменить переменные в файле системы проектирования из файла main.scss . Вы можете добавить свою собственную цветовую схему или изменить типографику и интервал. Настройки компонентов или дополнительных должны быть добавлены ниже импорта _uikit.scss . Изменения в этих файлах будут введены в ваш браузер, поэтому вам даже не нужно обновляться благодаря синхронизации браузера.

Папка docs в содержит все файлы, необходимые для публикации веб -сайта. Файл index.html ссылается на файл main.css File и script.min.js Assets для создания страницы. Мы называем docs с папками, потому что GitHub Pages использует папку DOCS для размещения статических веб -сайтов.

⬆ Вернуться к вершине

---

Предварительные условия

• Node.js 8 или выше , предпочтительно текущая версия LTS.

ПРИМЕЧАНИЕ. Если вы разрабатываете в Windows, убедитесь, что ваша локальная конфигурация npm использует оболочку, которая поддерживает путь Unix, например, папки (то есть a/unix/path а не a\windows\path ).

⬆ Вернуться к вершине

---

Внося

Чтобы внести свой вклад в стартовую пакет системы проектирования правительства Австралии:

1. Вилка проекта и клонировать его на местном уровне.
2. Создайте новый филиал для работы, которая будет завершена.
3. Заполните работу и протестируйте ее в меру своих способностей, следуя рекомендациям здесь.
4. Как только работа будет завершена, напишите хорошее сообщение о коммите.
5. Подтолкните свою работу, чтобы GitHub и создайте новый запрос на притяжение.
6. Ответьте на любой отзыв обзора кода.

⬆ Вернуться к вершине

---

Лицензия

Авторское право (C) Содружество Австралии. За исключением герб Содружества и где иное отмечается, эта работа лицензирована по лицензии MIT.

⬆ Вернуться к вершине

};