diff --git a/README.md b/README.md index 6f675c5bbdbd434b9040b27180f5e6aa4c038874..639bdd15e18f00114b69ef803d7edfd4c3739e64 100644 --- a/README.md +++ b/README.md @@ -1,58 +1 @@ -# Parcel boilerplate - -## Скрытые файлы - -Включите отображение Ñкрытых файлов и папок в проводнике Ñвоей операционной ÑиÑтемы, иначе вы не -Ñможете выбрать и Ñкопировать Ñебе файлы наÑтроек проекта, имена которых начинаютÑÑ Ñ Ñ‚Ð¾Ñ‡ÐºÐ¸. - -## ЗавиÑимоÑти - -Ðа компьютере должена быть уÑтановлена LTS-верÑÐ¸Ñ [Node.js](https://nodejs.org/en/) Ñо вÑеми -дополнительными инÑтрументами кроме **Chocolatey** - его Ñтавить не нужно. - -## Перед началом работы - -Один раз на проект уÑтановить вÑе завиÑимоÑти. - -```shell -npm ci -``` - -### Разработка - -ЗапуÑтить режим разработки. - -```shell -npm run dev -``` - -Во вкладке браузера перейти по адреÑу [http://localhost:1234](http://localhost:1234). - -### Деплой - -Сборка будет автоматичеÑки Ñобирать и деплоить продакшен верÑию проекта на GitHub Pages, в ветку -`gh-pages`, каждый раз когда обновлÑетÑÑ Ð²ÐµÑ‚ÐºÐ° `main`. Ðапример, поÑле прÑмого пуша или принÑтого -пул-реквеÑта. Ð”Ð»Ñ Ñтого необходимо в файле `package.json` отредактировать поле `homepage` и Ñкрипт -`build`, заменив `имÑ_пользователÑ` и `имÑ_репозиториÑ` на Ñвои. - -```json -"homepage": "https://имÑ_пользователÑ.github.io/имÑ_репозиториÑ", -"scripts": { - "build": "parcel build src/*.html --public-url /имÑ_репозиториÑ/" -}, -``` - -Ðа вÑÑкий Ñлучай Ñтоит зайти в наÑтройки Ñ€ÐµÐ¿Ð¾Ð·Ð¸Ñ‚Ð¾Ñ€Ð¸Ñ `Settings` > `Pages` и убедитьÑÑ Ñ‡Ñ‚Ð¾ продакшен -верÑии файлов раздаютÑÑ Ð¸Ð· папки `/root` ветки `gh-pages`. - -Через какое-то Ð²Ñ€ÐµÐ¼Ñ Ð¶Ð¸Ð²ÑƒÑŽ Ñтраницу можно будет поÑмотреть по адреÑу указанному в отредактированном -ÑвойÑтве `homepage`, например -[https://goitacademy.github.io/parcel-project-template](https://goitacademy.github.io/parcel-project-template). - -## Файлы и папки - -- Ð’Ñе паршалы файлов Ñтилей должны лежать в папке `src/sass` и импортироватьÑÑ Ð² - `src/sass/main.scss` -- Ð˜Ð·Ð¾Ð±Ñ€Ð°Ð¶ÐµÐ½Ð¸Ñ Ð´Ð¾Ð±Ð°Ð²Ð»Ñйте в папку `src/images`, заранее оптимизировав их. Сборщик проÑто копирует - иÑпользуемые Ð¸Ð·Ð¾Ð±Ñ€Ð°Ð¶ÐµÐ½Ð¸Ñ Ñ‡Ñ‚Ð¾Ð±Ñ‹ не нагружать ÑиÑтему оптимизацией картинок, так как на Ñлабых - компьютерах Ñто может занÑть много времени. +GoIT JS Team Project