Merge pull request #7 from choisohyun/feature/#6

[FEATURE] npm 배포 및 버전관리 자동화

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## 1.1.0 (2022-03-18)
+
+
+### Features
+
+* npx bin script ([e18cae8](https://github.com/choisohyun/react-vite-ts-boilerplate/commit/e18cae8293ee838055da3b38cd7dd6b7216d2348))
+* reset scss ([3637668](https://github.com/choisohyun/react-vite-ts-boilerplate/commit/36376686f59fa8e3ac54d95d6e090d0701b84033))
+
+
+### Bug Fixes
+
+* bin script key name ([67b017d](https://github.com/choisohyun/react-vite-ts-boilerplate/commit/67b017d041c7f2f6397a26207e3c29739103728f))
+* empty build error ([06500e8](https://github.com/choisohyun/react-vite-ts-boilerplate/commit/06500e8dc0303138862ec1038d104b9e5040c7f5))
+* example cmd log typo ([49dba04](https://github.com/choisohyun/react-vite-ts-boilerplate/commit/49dba046d1e6fcf385a1c8455c6029576e3221ee))
+* style import nothing bug ([df5e6e2](https://github.com/choisohyun/react-vite-ts-boilerplate/commit/df5e6e24249a2d0f78708a592edde7dbe11e5306))
+* typo ([6832577](https://github.com/choisohyun/react-vite-ts-boilerplate/commit/683257742eabacf4f85a335c367e640c6698807c))

README.md

@@ -1,19 +1,32 @@
+# Very Fast React Boilerplate
+
 <p align="center">
 
 ![header](https://capsule-render.vercel.app/api?type=waving&color=61DAFB&height=300&section=header&text=Very%20Fast%20React%20Boilerplate&fontSize=60&animation=fadeIn&fontAlignY=38&descAlignY=51&descAlign=62&fontColor=F5F8FA)
 
 </p>
 
-# Very Fast React Boilerplate
 
-[![npm version](https://badge.fury.io/js/react-vite-ts-boilerplate.svg)](https://badge.fury.io/js/react-vite-ts-boilerplate)
+[![npm version](https://badge.fury.io/js/react-vite-ts-boilerplate.svg)](https://www.npmjs.com/package/react-vite-ts-boilerplate)
+
+## Getting started
+
+1. Gets the git project. (Auto run installation)
+
+```
+  npx react-vite-ts-boilerplate my-app
+```
+
+2. Start the dev server. And open http://localhost:3000 in your browser.
 
-## How to use
+```
+  yarn dev
+```
+
+3. Build your product.
 
 ```
-npx react-vite-ts-boilerplate my-app
-yarn dev
-yarn prod
+  yarn prod
 ```
 
 ## Dependencies
@@ -24,6 +37,8 @@ yarn prod
 - eslint
 - Prettier
 
+## Performance
+
 - fast dev server
 
 ```bash
@@ -52,4 +67,3 @@ dist/assets/index.f377a083.js    2.09 KiB / gzip: 1.13 KiB
 dist/assets/vendor.5ad169fc.js   136.42 KiB / gzip: 44.42 KiB                                                                                                                                                                                                  21:57:45
 ✨  Done in 2.22s.
 ```
-

package.json

@@ -1,10 +1,11 @@
 {
   "name": "react-vite-ts-boilerplate",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "license": "MIT",
   "scripts": {
     "dev": "vite",
-    "prod": "vite build"
+    "prod": "vite build",
+    "release": "standard-version"
   },
   "bin": {
     "react-vite-ts-boilerplate": "./bin/react-vite-ts-boilerplate.js"
@@ -30,6 +31,8 @@
     "react-router-dom": "^6.2.1"
   },
   "devDependencies": {
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
     "@rollup/plugin-alias": "^3.1.9",
     "@types/react": "17.0.35",
     "@types/react-dom": "17.0.11",
@@ -52,15 +55,21 @@
     "postcss-nested": "^5.0.6",
     "prettier": "^2.4.1",
     "sass": "1.43.5",
+    "standard-version": "^9.3.2",
     "typescript": "^4.5.2",
     "vite": "^2.8.6",
     "vite-plugin-html": "^3.1.0",
     "vite-tsconfig-paths": "^3.4.1"
   },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
   "husky": {
     "hooks": {
-      "pre-commit": "lint-staged",
-      "post-commit": "standard-version"
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-commit": "lint-staged"
     }
   },
   "lint-staged": {

public/manifest.json

@@ -0,0 +1,17 @@
+{
+  "short_name": "react-vite-ts-boilerplate",
+  "name": "react-vite-ts-boilerplate",
+  "description": "react-vite-ts-boilerplate",
+  "icons": [
+    {
+      "src": "images/favicon.ico",
+      "type": "image/x-icon",
+      "sizes": "64x64"
+    }
+  ],
+  "start_url": "/",
+  "display": "standalone",
+  "orientation": "landscape",
+  "theme_color": "#ffffff",
+  "background_color": "#ffffff"
+}

public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Allow: /