readme.md

Author: wxwvx

readme.md

@@ -0,0 +1,28 @@
+# Учебный шаблон проекта Portfolio
+
+> Перед установкой зависимостей и запуском проекта убедитесь, что у вас установлена [последняя версия Node.js & NPM](https://nodejs.org/en/download/current/)
+
+##  Чтобы развернуть проект необходимо:
+```sh
+$ git clone git@github.com:loftschool/ls-advanced-portfolio.git
+$ cd ls-advanced-portfolio.git
+$ npm install
+```
+
+## Скрипты package.json:
+
+| Скрипт | Назначение |
+| ------ | ------ |
+| dev | Запустит webpack-dev-server с _горячей_ заменой модулей |
+| build | Соберет проект для **production** (проект готов к загрузке на сервер) |
+| reg | Консольная утилита для регистрации. Использовать перед началом работы над **админ-панелью**. |
+
+#### Чтобы запустить скрипт:
+```sh
+$ npm run имя_скрипта
+```
+
+##### Либо:
+```sh
+$ yarn имя_скрипта
+```