diff --git a/README.md b/README.md index 06b87b7f63402b578bdebd8eb051343da04d80d0..4ac45c8c94da2dce9ca3e78f166cad866fd37284 100644 --- a/README.md +++ b/README.md @@ -1 +1,82 @@ -# parcel-project-template \ No newline at end of file +# parcel-project-template + +## Developing + +### Prerequisites + +Ð”Ð»Ñ ÐºÐ¾Ñ€Ñ€ÐµÐºÑ‚Ð½Ð¾Ð¹ работы SASS-компилÑтора и других инÑтрументов, необходимо один +раз глобально поÑтавить дополнительные пакеты, выполнив в терминале Ñледующие +команды. ПользователÑм MacOS ничего делать не нужно. + +ПользователÑм **Windows**, в режиме админиÑтратора. + +```shell +npm install --global windows-build-tools +``` + +ПользователÑм **Linux**. + +```shell +sudo apt-get install gcc g++ make +``` + +### Setting up Dev + +Один раз на проект уÑтановить вÑе завиÑимоÑти. + +```shell +npm install +``` + +И запуÑтить режим разработки. + +```shell +npm start +``` + +Во вкладке браузера перейти по адреÑу +[http://localhost:1234](http://localhost:1234). + +### Building + +Ð”Ð»Ñ Ñ‚Ð¾Ð³Ð¾ чтобы Ñоздать оптимизированные файлы Ð´Ð»Ñ Ñ…Ð¾Ñтинга, необходимо выполнить +Ñледующую команду. Ð’ корне проекта поÑвитÑÑ Ð¿Ð°Ð¿ÐºÐ° `build` Ñо вÑеми +оптимизированными реÑурÑами. + +```shell +npm run build +``` + +### Deploying / Publishing + +Сборка может автоматичеÑки деплоить билд на GitHub Pages удаленного (remote) +репозиториÑ. Ð”Ð»Ñ Ñтого необходимо в файле `package.json` отредактировать поле +`homepage`, заменив Ð¸Ð¼Ñ Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ Ð¸ Ñ€ÐµÐ¿Ð¾Ð·Ð¸Ñ‚Ð¾Ñ€Ð¸Ñ Ð½Ð° Ñвои. + +```json +"homepage": "https://имÑ_пользователÑ.github.io/имÑ_репозиториÑ" +``` + +Также необходимо отредактировать Ñкрипт "predeploy". + +```json +"predeploy": "npm run build -- --public-url='/имÑ_репозиториÑ/'" +``` + +ПоÑле чего в терминале выполнить Ñледующую команду. + +```shell +npm run deploy +``` + +ЕÑли нет ошибок в коде и ÑвойÑтво `homepage` указано верно, запуÑтитÑÑ Ñборка +проекта в продакшен, поÑле чего Ñодержимое папки `build` будет помещено в ветку +`gh-pages` на удаленном (remote) репозитории. Через какое-то Ð²Ñ€ÐµÐ¼Ñ Ð¶Ð¸Ð²ÑƒÑŽ +Ñтраницу можно будет поÑмотреть по адреÑу указанному в отредактированном +ÑвойÑтве `homepage`. + +## Configuration + +- Ð’Ñе паршалы файлов Ñтилей должны лежать в папке `src/sass` и импортироватьÑÑ Ð² + `src/sass/main.scss` +- Ð˜Ð·Ð¾Ð±Ñ€Ð°Ð¶ÐµÐ½Ð¸Ñ Ð´Ð¾Ð±Ð°Ð²Ð»Ñйте в папку `src/images` diff --git a/src/images/demo.jpg b/src/images/demo.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3d26b41648f0609274bc12fa0a349600ec502d80 Binary files /dev/null and b/src/images/demo.jpg differ diff --git a/src/sass/main.scss b/src/sass/main.scss index c0919efe8d86760603cc30456a5c64f2aae272b9..269c79c220a767121139a76b961826ddf0aba61e 100644 --- a/src/sass/main.scss +++ b/src/sass/main.scss @@ -4,4 +4,4 @@ */ // Стили Ð´Ð»Ñ Ñ„Ð°Ð¹Ð»Ð° Ñ Ð¿Ñ€Ð¸Ð¼ÐµÑ€Ð¾Ð¼ HTML-фрагмента -@import "./example"; +@import './example';