diff --git a/.gitignore b/.gitignore index 403adbc..4a2e501 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ .DS_Store node_modules -/dist # local env files diff --git a/README.md b/README.md index 3f5b10d..4fb1aab 100644 --- a/README.md +++ b/README.md @@ -50,36 +50,43 @@ and also included vuex, vue-router - [Activity](#activity-app) (Template: [src/data/activity.json](src/data/activity.json)) - [Other](#other) +## 🚀 Deploy + +- 👉 [Github Page](docs/DEPLOY_GITHUB_PAGE.md) +- 👍 Manually + ### Base Base configuration: [src/data/\_base.json](src/data/_base.json) -| Property | Description | Example | -| :----------------------- | :--------------------------------------------------- | :---------------------------------: | -| `app` | PWA Configuration | - | -| `app.name` | PWA Name | `Résume` | -| `app.themeColor` | PWA Theme color (CSS Color) | `#ffffff` | -| `title` | Web title (in head) | `Résume | Geunhyeok LEE` | -| `ga` | Google analytics tracking ID (Optional) | `UA-000000000-0` | -| `introText[]` | Intro text (Each line), og description | `["For better", "Web experience."]` | -| `profile` | Your profile informations | - | -| `profile.name` | Name | `Geunhyeok LEE` | -| `profile.email` | Email | `dev.ghlee@gmail.com` | -| `profile.photo` | Profile photo filename at `src/assets` | `avatar.png` | -| `profile.introduce` | Introduce your self | `Makes web better` | -| `profile.social[]` | Social informations in Contact app ([more](#social)) | - | -| `profile.social[].icon` | Social Icon (Check SocialIcon) | `github` | -| `profile.social[].label` | Social text to be displayed | `Github` | -| `profile.social[].url` | Page URL to go | `https://github.com/leegeunhyeok` | -| `profile.skill[]` | Your own skills list ([more](#skill)) | - | -| `profile.skill[].label` | Skill text to be displayed | `TypeScript` | -| `profile.skill[].color` | Skill's dot color ([more](#colors)) | `ts` | -| `profile.hobby[]` | Your hobby (Max: 2) | `["프로그래밍", "운동"]` | +| Property | Description | Example | +| :----------------------- | :-------------------------------------------------------------- | :---------------------------------: | +| `publicPath` | Webpack [publicPath](https://webpack.js.org/guides/public-path) | `/` | +| `app` | PWA Configuration | - | +| `app.name` | PWA Name | `Résume` | +| `app.themeColor` | PWA Theme color (CSS Color) | `#ffffff` | +| `title` | Web title (in head) | `Résume | Geunhyeok LEE` | +| `ga` | Google analytics tracking ID (Optional) | `UA-000000000-0` | +| `introText[]` | Intro text (Each line), og description | `["For better", "Web experience."]` | +| `profile` | Your profile informations | - | +| `profile.name` | Name | `Geunhyeok LEE` | +| `profile.email` | Email | `dev.ghlee@gmail.com` | +| `profile.photo` | Profile photo filename at `src/assets` | `avatar.png` | +| `profile.introduce` | Introduce your self | `Makes web better` | +| `profile.social[]` | Social informations in Contact app ([more](#social)) | - | +| `profile.social[].icon` | Social Icon (Check SocialIcon) | `github` | +| `profile.social[].label` | Social text to be displayed | `Github` | +| `profile.social[].url` | Page URL to go | `https://github.com/leegeunhyeok` | +| `profile.skill[]` | Your own skills list ([more](#skill)) | - | +| `profile.skill[].label` | Skill text to be displayed | `TypeScript` | +| `profile.skill[].color` | Skill's dot color ([more](#colors)) | `ts` | +| `profile.hobby[]` | Your hobby (Max: 2) | `["프로그래밍", "운동"]` | Example ```json { + "publicPath": "/", "app": { "name": "Résume", "themeColor": "#ffffff" diff --git a/docs/DEPLOY_GITHUB_PAGE.md b/docs/DEPLOY_GITHUB_PAGE.md new file mode 100644 index 0000000..1d453bd --- /dev/null +++ b/docs/DEPLOY_GITHUB_PAGE.md @@ -0,0 +1,45 @@ +# Deploy - Github Page + +## 1. Create Github repository + +create repository 1 + +create repository 2 + +## 2. Clone craeted repository + +- Configuration your own template data - [Template configuration](https://github.com/leegeunhyeok/resume#-template-configuration) + +## 3. Build configuration + +- `src/data/_base.json` + +```js +{ + "publicPath": "/dist", // set publicPath to /dist + ... +} +``` + +## 4. Build + +```bash +# Build +npm run build +``` + +and move `dist/index.html` to `./` (Repository root directory) + +## 5. Commit and Push + +```bash +# Staging all changes (build result included!) +git add . + +# Your remote/branch +git push origin master +``` + +## 6. Enjoy! + +🎉 Go to your Github pages! diff --git a/docs/gp_1.jpg b/docs/gp_1.jpg new file mode 100644 index 0000000..9c0c1b7 Binary files /dev/null and b/docs/gp_1.jpg differ diff --git a/docs/gp_2.jpg b/docs/gp_2.jpg new file mode 100644 index 0000000..b25c80c Binary files /dev/null and b/docs/gp_2.jpg differ diff --git a/src/data/_base.json b/src/data/_base.json index a1da486..f7d7bca 100644 --- a/src/data/_base.json +++ b/src/data/_base.json @@ -1,6 +1,7 @@ { + "publicPath": "/", "app": { - "name": "GDev", + "name": "Résume", "themeColor": "#ffffff" }, "title": "Résume | Geunhyeok LEE", diff --git a/src/router/index.ts b/src/router/index.ts index d313e71..cf8d864 100644 --- a/src/router/index.ts +++ b/src/router/index.ts @@ -16,7 +16,7 @@ const routes: Array = [ ]; const router = createRouter({ - history: createWebHistory(process.env.BASE_URL), + history: createWebHistory('/'), routes, }); diff --git a/vue.config.js b/vue.config.js index aaeb783..1f1a7a3 100644 --- a/vue.config.js +++ b/vue.config.js @@ -18,7 +18,7 @@ const generateGAScript = trackingId => ` `; -const publicPath = process.env.NODE_ENV === 'development' ? '/' : '/dist'; +const publicPath = process.env.NODE_ENV === 'development' ? '/' : _Base.publicPath || '/dist'; module.exports = { productionSourceMap: false,