Skip to content

BAID-CSClub/baid-website-next

Repository files navigation

BAID Website @ Next

项目结构

  • src - 源码

    • assets - 页面内使用的素材,会被随机重命名

      • styles - 全局样式
        • desktop.css
        • mobile.css
      • fonts - 字体
      • images - 图片,只在一个页面中用到的图片请放入文件夹内
      • videos - 视频,命名方式与图片类似
    • components - 全部非页面组件放到这里,命名一律为多词 CamelCase

      如果是仅限于某个 view 内使用的组件,请将其放在一个文件夹内,文件夹名称类似 DesktopAboutUs

    • layouts - 基础布局

      • DesktopLayout.vue - 桌面端的默认布局
      • MobileLayout.vue - 移动端的默认布局
    • views - 全部页面组件,每个页面都需要有桌面端的和移动端的,两个组件名称需相同

      • desktop - 桌面端页面组件
      • mobile - 移动端页面组件
    • main.js - 入口

    • App.vue - 根组件

    • messages.json - 全部字符串+翻译

    • router.js - SPA 路由部分

    • i18n.js - 国际化部分

开发时可能要用到的命令

理论上可以用任何PM

  • yarn - 安装依赖
  • yarn dev - 打开开发服务器(Vite)
  • yarn test - 检查代码有无任何不规范
  • yarn build - 生成静态构建

开发时可能要用到的资料

推荐启用的 VSCode 拓展

  • Volar (不要使用 Vetur)
  • Prettier ESLint (已配置开箱即用)
  • UnoCSS

If you want to update npm dependencies:

It was tested that these following packages shoud have their versions pinned:

  • swiper - ^8

    swiper is kinda an active project, and its maintainers are quite "radical". They are usually vigorously testing out latest standards (e.g. WebComponents) and leaving old technics behind. Thus updating this package to its latest version usually breaks several APIs and please don't do that.

  • prettier - ^2

    It's been a while since the last time that prettier-eslint was updated. Cause prettier-eslint depends on [email protected], any updates will break yarn format.

There should not be any problems with other deps. Feel free to ignite yarn upgrade -L.