Skip to content

Commit

Permalink
add: readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ErickKS authored Jan 27, 2023
1 parent e2d5062 commit a429e37
Showing 1 changed file with 108 additions and 0 deletions.
108 changes: 108 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit a429e37

Please sign in to comment.