Merge pull request #42 from TENEr98/master

chore: README.md refactored and .vscode added extensions  and settings

.vscode/extensions.json

@@ -0,0 +1,11 @@
+{
+   "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "eamodio.gitlens",
+    "esbenp.prettier-vscode",
+    "ecmel.vscode-html-css",
+    "sainoba.px-to-rem",
+    "streetsidesoftware.code-spell-checker",
+    "streetsidesoftware.code-spell-checker-russian",
+   ]
+}

.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+  "git.autofetch": true,
+  "cSpell.language": "en, ru",
+  "workbench.iconTheme": "material-icon-theme",
+  "[html][css][scss][javascript]": {
+    "editor.tabSize": 2,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.tabSize": 2
+  },
+  "editor.tabSize": 2,
+  "scm.alwaysShowActions": true,
+  "editor.formatOnSave": true,
+  "terminal.integrated.defaultProfile.osx": "bash",
+  "terminal.integrated.defaultProfile.linux": "bash",
+  "terminal.integrated.defaultProfile.windows":"bash"
+}

README.md

@@ -1,72 +1,126 @@
 # Webpack Static Site Starter Kit
 
 ## Требования к проекту
+
 - [Node 14.18.3](https://nodejs.org/download/release/v14.18.3/)
 - [NVM/MacOC](https://tecadmin.net/install-nvm-macos-with-homebrew/)
 - [NVM/Windows](https://github.com/coreybutler/nvm-windows/releases) Если Windows то установка только от имени администратора
 - [Yarn](https://yarnpkg.com/)
 
+---
+
 ## Использование
-##### Клонировать репозиторий
-```
+
+Клонировать репозиторий
+
+```bash
 git clone https://github.com/alex-karo/webpack-static-template block7
 ```
-##### В папке block7 перейти в папку проекта
-```
+
+В папке block7 перейти в папку проекта
+
+```bash
 cd block7
 ```
-##### Удалить папку .git
+
+Удалить папку .git
+
+```bash
+rm -rf .git
 ```
-rm -fr .git
+
+---
+
+## Если создаете новый проект в github.com
+
+нужно будет инициализировать git проект, _если данная команда не сработает значит версия git установлена старая, нужно обновить её_
+
+```properties
+git init -b main
 ```
 
-## Проверка версии ноды
-##### Должно вывести версию ноды 14.18.3
+добавить все изменения и сделать первый коммит
+
+```properties
+git add . && git commit -m "initial commit"
 ```
+
+соединить git удаленный с локальным, *USER* (пользователь) и *REPO* (репозиторий)
+
+```properties
+git remote add origin https://github.com/USER/REPO.git
+```
+
+проверить на то что есть соединение
+
+```properties
+git remote -v
+```
+
+отправить изменения в удаленный репозиторий
+
+```properties
+git push origin main
+```
+
+---
+
+## Проверка версии ноды
+
+Должно вывести версию ноды 14.18.3
+
+```properties
 node -v
 ```
 
+---
+
 ## Два метода установки зависимостей
-##### Установка зависимостей через NPM
 
-```
+Установка зависимостей через NPM
+
+```properties
 npm install
 ```
-##### Установка зависимостей через Yarn
-```
+
+Установка зависимостей через Yarn
+
+```properties
 yarn
 ```
 
+---
+
 ## Два метода запуска приложения
-#### Для запуска веб-сервера с лайврелоадом через NPM
-```
+
+Для запуска веб-сервера через NPM
+
+```properties
 npm run start
 ```
-#### Для создания билда через NPM
-```
-npm run build
-```
 
+Для запуска веб-сервера через Yarn
 
-#### Для запуска веб-сервера с лайврелоадом через Yarn
-```
+```properties
 yarn start
 ```
-#### Для создания билда через Yarn
-```
-yarn build
-```
+
+---
 
 ## Два метода загрузки на Github Pages
-**Ваш репозиторий должен быть связан с github репозиторием, после этого выполняем**
-#### Загрузка на Github Pages через NPM
-```
+
+### Ваш репозиторий должен быть связан с github.com репозиторием, после этого выполняем
+
+Загрузка на Github Pages через NPM
+
+```properties
 npm run deploy
 ```
-#### Загрузка на Github Pages через Yarn
-```
+
+Загрузка на Github Pages через Yarn
+
+```properties
 yarn deploy
 ```
 
-Основано на [этой статье](https://hackernoon.com/lets-start-with-webpack-4-91a0f1dba02e)
-
+Основано на [этой статье](https://hackernoon.com/lets-start-with-webpack-4-91a0f1dba02e)

package.json

@@ -1,10 +1,16 @@
 {
-  "name": "webpack-test",
+  "name": "web-last-block",
   "version": "1.0.0",
   "description": "",
-  "keywords": [],
+  "keywords": [
+    "web",
+    "scss",
+    "html",
+    "javascript",
+    "webpack"
+  ],
   "license": "ISC",
-  "author": "",
+  "author": "Kata Academy",
   "main": "index.js",
   "scripts": {
     "build": "webpack --mode production",
@@ -20,7 +26,6 @@
     "not OperaMini All",
     "not dead"
   ],
-
   "devDependencies": {
     "@babel/core": "7.5.5",
     "@babel/preset-env": "7.5.5",
@@ -39,11 +44,11 @@
     "webpack-cli": "3.3.7",
     "webpack-dev-server": "^3.11.0"
   },
+  "engineStrict": true,
   "engines": {
     "node": "~14.18.3",
     "npm": "~6.14.15"
   },
-  "engineStrict": true,
   "postcss": {
     "plugins": {
       "autoprefixer": {}

src/index.html

@@ -1,14 +1,16 @@
 <!DOCTYPE html>
 <html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport"
-          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
-    <meta http-equiv="X-UA-Compatible" content="ie=edge">
+  <head>
+    <meta charset="UTF-8" />
+    <meta
+      name="viewport"
+      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
+    />
+    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
     <title><%= htmlWebpackPlugin.options.title %></title>
-</head>
-<body>
-<img src="./img/webpack.svg" alt="Webpack Logo" width="200px">
-<h3>Welcome to Webpack 4 starter </h3>
-</body>
+  </head>
+  <body>
+    <img src="./img/webpack.svg" alt="Webpack Logo" width="200px" />
+    <h3>Welcome to Webpack 4 starter </h3>
+  </body>
 </html>

src/js/index.js

@@ -1,3 +1,3 @@
-import '../scss/style.scss';
+import '../scss/style.scss'
 
-console.log('Works!');
+console.log('Works!')