Skip to content
CLDXiang edited this page Apr 11, 2021 · 14 revisions

这里是 today-frontend 的 wiki 页面!😉

项目介绍

此项目借助 vue-cli 构建,采用 Vue 3 + TypeScript + vuex + vue-router,开发辅助工具有 eslint, prettier;css 正从 sass 向 postcss 和 tailwindcss 过渡; 正尝试逐步抛弃 AntDesign 组件;还有一些辅助的小库:

  • dayjs: 处理时间日期
  • lodash: 著名库,常用功能(或许会被放弃)
  • axios: 请求中间件
  • ...

工程目录结构

src
├── apis                     : API 定义
├── App.vue                  : Vue 主组件
├── assets                   : 静态资源
├── components               : 全局组件库
├── composables              : 全局 Composition API 钩子
├── index.css                : 全局 CSS 文件,亦为 TailwindCSS 引入处
├── main.ts                  : 项目编译入口
├── registerServiceWorker.ts : service worker
├── router                   : vue-router 相关,路由定义与控制
├── scss                     : 一些 scss 文件
├── shims-vue.d.ts           : Vue TS 类型声明
├── store                    : Vuex 相关,全局状态管理
├── utils                    : 工具函数
└── views                    : 具体页面实现

开发规约与建议

每一位参与项目开发的同学都需要遵循开发规约与建议中约定的事项。

Commit 规范

你的所有 commit messages 会通过 commitlint 进行检查,如果不满足要求将无法进行提交。具体规则可前往 commitlint README 查看。

Clone this wiki locally