Skip to content
Snippets Groups Projects
Commit 2b7affc0 authored by Alexander Repeta's avatar Alexander Repeta
Browse files

update readme

parent 0011a300
No related branches found
No related tags found
No related merge requests found
# parcel-project-template
## Developing
## Зависимости
### Prerequisites
На компьютере должена быть установлена LTS-версия
[Node.js](https://nodejs.org/en/).
На компьютере должен быть установлен [Node.js](https://nodejs.org/en/).
Для корректной работы SASS-компилятора и других инструментов, необходимо один
раз глобально поставить дополнительные пакеты, выполнив в терминале следующие
команды. Пользователям MacOS ничего делать не нужно.
Пользователям **Windows**, в режиме администратора.
[Как запусттить Powershell](https://youtu.be/p2tFnxcymwk) в режиме
администратора.
```shell
npm install --global --production windows-build-tools
```
Вот как выглядит процесс успешной установки для пользователей **Windows**.
![Установка windows-build-tools](https://user-images.githubusercontent.com/1426799/45007904-bde9f280-afb4-11e8-8a35-c77dffaffa2a.gif)
Пользователям **Linux**.
```shell
sudo apt-get install gcc g++ make
```
### Setting up Dev
## Перед началом работы
Один раз на проект установить все зависимости.
```shell
npm install
npm ci
```
И запустить режим разработки.
### Разработка
Запустить режим разработки.
```shell
npm run dev
......@@ -45,17 +24,7 @@ npm run dev
Во вкладке браузера перейти по адресу
[http://localhost:1234](http://localhost:1234).
### Building
Для того чтобы создать оптимизированные файлы для хостинга, необходимо выполнить
следующую команду. В корне проекта появится папка `build` со всеми
оптимизированными ресурсами.
```shell
npm run build
```
### Deploying / Publishing
### Деплой
Сборка может автоматически деплоить билд на GitHub Pages удаленного (remote)
репозитория. Для этого необходимо в файле `package.json` отредактировать поле
......@@ -83,11 +52,11 @@ npm run deploy
страницу можно будет посмотреть по адресу указанному в отредактированном
свойстве `homepage`.
## Configuration
## Файлы и папкм
- Все паршалы файлов стилей должны лежать в папке `src/sass` и импортироваться в
`src/sass/main.scss`
- Изображения добавляйте в папку `src/images`, заранее оптимизировав их. Сборщик
просто копирует используемые изображения чтобы не нагружать вашу систему
оптимизацией десятков картинок, так как на слабых компьютерах это повесит
систему.
просто копирует используемые изображения чтобы не нагружать систему
оптимизацией картинок, так как на слабых компьютерах это может занять прилично
времени.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment