Oh My CV 项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_01121/article/details/142239059

Oh My CV 项目教程

oh-my-cv An in-browser, local-first Markdown resume builder. 项目地址: https://gitcode.com/gh_mirrors/oh/oh-my-cv

1. 项目的目录结构及介绍

oh-my-cv/
├── .github/
│   └── workflows/
├── public/
│   ├── assets/
│   ├── fonts/
│   └── index.html
├── src/
│   ├── assets/
│   ├── components/
│   ├── layouts/
│   ├── pages/
│   ├── plugins/
│   ├── router/
│   ├── store/
│   ├── styles/
│   ├── utils/
│   ├── App.vue
│   └── main.ts
├── .editorconfig
├── .eslintrc.js
├── .gitignore
├── .npmrc
├── LICENSE
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── README.md
└── tsconfig.base.json

目录结构介绍

.github/workflows/: 存放 GitHub Actions 的工作流配置文件。
public/: 存放静态资源文件，如图片、字体等。
src/: 项目的主要源代码目录。
- assets/: 存放项目中使用的静态资源文件。
- components/: 存放 Vue 组件。
- layouts/: 存放页面布局组件。
- pages/: 存放页面组件。
- plugins/: 存放 Vue 插件。
- router/: 存放 Vue Router 配置文件。
- store/: 存放 Vuex 状态管理文件。
- styles/: 存放全局样式文件。
- utils/: 存放工具函数。
- App.vue: 项目的根组件。
- main.ts: 项目的入口文件。
.editorconfig: 编辑器配置文件。
.eslintrc.js: ESLint 配置文件。
.gitignore: Git 忽略文件配置。
.npmrc: npm 配置文件。
LICENSE: 项目许可证文件。
package.json: 项目依赖和脚本配置文件。
pnpm-lock.yaml: pnpm 锁定文件。
pnpm-workspace.yaml: pnpm 工作区配置文件。
README.md: 项目说明文件。
tsconfig.base.json: TypeScript 配置文件。

2. 项目的启动文件介绍

main.ts

main.ts 是项目的入口文件，负责初始化 Vue 应用并挂载到 DOM 上。以下是 main.ts 的主要内容：

import { createApp } from 'vue';
import App from './App.vue';
import router from './router';
import store from './store';

createApp(App)
  .use(store)
  .use(router)
  .mount('#app');

文件功能介绍

createApp(App): 创建 Vue 应用实例。
use(store): 注册 Vuex 状态管理。
use(router): 注册 Vue Router。
mount('#app'): 将应用挂载到 DOM 元素 #app 上。

3. 项目的配置文件介绍

package.json

package.json 是项目的依赖和脚本配置文件，包含了项目的基本信息、依赖包、脚本命令等。以下是 package.json 的部分内容：

{
  "name": "oh-my-cv",
  "version": "1.0.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "vue": "^3.0.0",
    "vue-router": "^4.0.0",
    "vuex": "^4.0.0"
  },
  "devDependencies": {
    "@vue/cli-plugin-babel": "~4.5.0",
    "@vue/cli-plugin-eslint": "~4.5.0",
    "@vue/cli-service": "~4.5.0"
  }
}

配置文件功能介绍

scripts: 定义了项目的脚本命令，如 serve、build、lint 等。
dependencies: 项目运行时所需的依赖包。
devDependencies: 开发环境所需的依赖包。

.eslintrc.js

eslintrc.js 是 ESLint 的配置文件，用于定义代码风格和规则。以下是 eslintrc.js 的部分内容：

module.exports = {
  root: true,
  env: {
    node: true
  },
  extends: [
    'plugin:vue/vue3-essential',
    'eslint:recommended'
  ],
  parserOptions: {
    parser: 'babel-eslint'
  },
  rules: {
    // 自定义规则
  }
};