From a429e372ea605916935175c68f3e84a5dc8af888 Mon Sep 17 00:00:00 2001
From: Erick Kuwahara <80263417+ErickKS@users.noreply.github.com>
Date: Fri, 27 Jan 2023 20:15:29 -0300
Subject: [PATCH] add: readme.md

---
 README.md | 108 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 108 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..23d272c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,108 @@
+<div align="center">
+    <h2>⚜️ V I T E &nbsp; D E P L O Y ⚜️</h2>
+</div>
+
+<div align="center">
+    <a href="https://www.youtube.com/watch?v=XhoWXhyuW_I">youtube video</a>
+</div>
+
+<br>
+
+### Follow the steps below on how to deploy a vite react app:
+
+#### 01. Create a vite react app
+```npm
+npm create vite@latest
+```
+
+#### 02. Create a new repository on GitHub and initialize GIT
+```git
+git init 
+git add . 
+git commit -m "add: initial files" 
+git branch -M main 
+git remote add origin https://github.com/[USER]/[REPO_NAME] 
+git push -u origin main
+```
+
+#### 03. Setup base on *vite.config*
+```js
+base: "/[REPO_NAME]/"
+```
+
+#### 04. Create ./github/workflows/deploy.yml and add the code bellow
+```yml
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      - name: Install dependencies
+        uses: bahmutov/npm-install@v1
+
+      - name: Build project
+        run: npm run build
+
+      - name: Upload production-ready build files
+        uses: actions/upload-artifact@v2
+        with:
+          name: production-files
+          path: ./dist
+
+  deploy:
+    name: Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: production-files
+          path: ./dist
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist
+```
+
+#### 05. Push
+```git
+git add . 
+git commit -m "add: deploy workflow" 
+git push
+```
+
+#### 06. Active workflow
+```js
+Config -> Actions -> General -> Workflow permissions -> Read and Write permissions 
+Actions -> failed deploy -> re-run-job failed jobs 
+Pages -> gh-pages -> save
+```
+
+#### 06. For code changes
+```git
+git add . 
+git commit -m "fix: some bug" 
+git push
+```
+Whenever you push to GitHub, it will deply automatically