create-young-proj 0.13.0 → 1.0.0

package/template-nuxt-website/README.md

@@ -0,0 +1,117 @@
+# 基于 Nuxt 3 的服务端渲染响应式网站
+
+
+[![](https://img.shields.io/badge/Author-BluesYoung--web-blue)](https://gitee.com/BluesYoung-web)
+
+[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
+
+## 注意
+
+> `useFetch + $fetch + NuxtLink + navigateTo` 组合使用，可以极大提升用户体验
+
+```ts
+navigateTo('/url?a=1&b=2')
+// ===>
+navigateTo({
+  path: '/url',
+  query: {
+    a: 1,
+    b: 2
+  }
+})
+```
+
+> `definePageMeta` 的 `name` 不得重复
+
+### 图片大小
+
+**`asstes` 内的图片不得大于 4k**，超过大小的图片需要转换为 `webp` 后上传至 `cdn`
+
+## 特性
+
+- 基于 [@nuxtjs/device](https://github.com/nuxt-modules/device) 的设备判断
+
+- 基于 [@unocss/nuxt](https://github.com/unocss/unocss) 的样式自动生成
+
+- 基于 [@formkit/auto-animate](https://auto-animate.formkit.com/#usage-vue) 的自动动画
+
+- 基于 [@bluesyoung/nuxt3-lazy-load](https://www.npmjs.com/package/@bluesyoung/nuxt3-lazy-load) 的图片懒加载
+
+## 配套 git 提交工具
+
+### 安装
+
+```bash
+npm i -g young-commit
+```
+
+### 使用
+
+
+- 正常使用 `git add` 将要提交的文件添加到暂存区
+
+- 提交步骤使用 `yc` 或者 `young-commit` 进行提交
+
+#### 命令选项
+
+- `yc -i` 初始化(仅刚创建项目时使用，会自动执行 `git init`)
+
+- `yc -r` 进行版本发布，会根据之前的提交及最近一个 `tag` 生成 `changelog`
+
+
+## 使用响应式布局
+
+兼容 `PC` 端与移动端
+
+**移动端最低兼容钉钉浏览器**
+
+## 常用的操作
+
+### 抛出错误
+
+```ts
+throw createError({ statusCode: 404, message: '数据迷路了' })
+```
+
+### 响应式屏幕尺寸
+
+
+```ts
+/*
+export const WindowSize = reactive({
+  'lt-sm': useMediaQuery('(max-width: 639.9px)'),
+  'sm': useMediaQuery('(min-width: 640px)'),
+  'lt-md': useMediaQuery('(max-width: 767.9px)'),
+  'md': useMediaQuery('(min-width: 768px)'),
+  'lt-lg': useMediaQuery('(max-width: 1023.9px)'),
+  'lg': useMediaQuery('(min-width: 1024px)'),
+  'lt-xl': useMediaQuery('(max-width: 1279.9px)'),
+  'xl': useMediaQuery('(min-width: 1280px)'),
+  'lt-2xl': useMediaQuery('(max-width: 1535.9px)'),
+  '2xl': useMediaQuery('(min-width: 1536px)'),
+});
+*/
+```
+
+### 设备判断
+
+```ts
+const $device = useDevice()
+
+$device.isDesktop
+$device.isMobile
+$device.isTablet
+$device.isMobileOrTablet
+$device.isDesktopOrTablet
+$device.isIos
+$device.isWindows
+$device.isMacOS
+$device.isApple
+$device.isAndroid
+$device.isFirefox
+$device.isEdge
+$device.isChrome
+$device.isSafari
+$device.isSamsung
+$device.isCrawler
+```

package/template-uni-app/README.md

@@ -1,5 +1,10 @@
 # 基于 uni-app + vue3 + ts + pinia + unocss 的小程序模板
 
+
+[![](https://img.shields.io/badge/Author-BluesYoung--web-blue)](https://gitee.com/BluesYoung-web)
+
+[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
+
 ## 配套 git 提交工具
 
 ### 安装

package/template-admin-server/.editorconfig

@@ -1,11 +0,0 @@
-# 🎨 editorconfig.org
-
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_style = space
-indent_size = 2
-trim_trailing_whitespace = true
-insert_final_newline = true

package/template-admin-server/.nvmrc

@@ -1 +0,0 @@
-16

package/template-admin-server/.vscode/extensions.json

@@ -1,6 +0,0 @@
-{
-  "recommendations": [
-    "rome.rome",
-    "obkoro1.korofileheader",
-  ]
-}

package/template-admin-server/.vscode/settings.json

@@ -1,4 +0,0 @@
-{
-  "editor.formatOnSave": true,
-  "editor.defaultFormatter": "rome.rome"
-}

package/template-admin-server/_gitignore

@@ -1,15 +0,0 @@
-logs/
-npm-debug.log
-yarn-error.log
-node_modules/
-package-lock.json
-yarn.lock
-coverage/
-dist/
-.idea/
-run/
-.DS_Store
-*.sw*
-*.un~
-.tsbuildinfo
-.tsbuildinfo.*

package/template-admin-server/boot.mjs

@@ -1,11 +0,0 @@
-/*
- * @Author: zhangyang
- * @Date: 2022-12-27 10:51:48
- * @LastEditTime: 2022-12-27 10:51:49
- * @Description:
- */
-import { Bootstrap } from '@midwayjs/bootstrap';
-
-Bootstrap.run().then(() => {
-  console.log('midway server is running!');
-});

package/template-admin-server/package.json

@@ -1,60 +0,0 @@
-{
-  "name": "midway_music_server",
-  "version": "1.0.0",
-  "description": "",
-  "type": "commonjs",
-  "private": true,
-  "dependencies": {
-    "@koa/cors": "^4.0.0",
-    "@midwayjs/bootstrap": "^3.0.0",
-    "@midwayjs/cache": "3",
-    "@midwayjs/core": "^3.0.0",
-    "@midwayjs/decorator": "^3.0.0",
-    "@midwayjs/info": "^3.0.0",
-    "@midwayjs/jwt": "^3.9.0",
-    "@midwayjs/koa": "^3.0.0",
-    "@midwayjs/logger": "^2.14.0",
-    "@midwayjs/passport": "3",
-    "@midwayjs/typeorm": "3",
-    "@midwayjs/validate": "^3.0.0",
-    "cache-manager": "^5.1.4",
-    "dayjs": "^1.11.7",
-    "defu": "^6.1.1",
-    "md5": "^2.3.0",
-    "mysql2": "^2.3.3",
-    "passport-jwt": "^4.0.1",
-    "reflect-metadata": "^0.1.13",
-    "typeorm": "^0.3.11"
-  },
-  "devDependencies": {
-    "@midwayjs/cli": "^2.0.0",
-    "@midwayjs/mock": "^3.9.0",
-    "@types/cache-manager": "^4.0.2",
-    "@types/koa": "^2.13.4",
-    "@types/koa__cors": "^3.3.0",
-    "@types/md5": "^2.3.2",
-    "@types/node": "16",
-    "cross-env": "^6.0.0",
-    "rome": "^11.0.0",
-    "typescript": "~4.8.0"
-  },
-  "engines": {
-    "node": ">=12.0.0"
-  },
-  "scripts": {
-    "start": "cross-env NODE_ENV=production node ./boot.mjs",
-    "dev": "cross-env NODE_ENV=local midway-bin dev --ts",
-    "build": "midway-bin build -c",
-    "format": "rome format * --write"
-  },
-  "midway-bin-clean": [
-    ".vscode/.tsbuildinfo",
-    "dist"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://gitee.com/BluesYoung-web/midway_music_server.git"
-  },
-  "author": "BluesYoung-web",
-  "license": "MIT"
-}

package/template-admin-server/rome.json

@@ -1,22 +0,0 @@
-{
-  "formatter": {
-    "ignore": [
-      "dist/*",
-      "*.html",
-      "yarn.lock",
-      "*.json",
-      "*.md"
-    ],
-    "indentStyle": "space",
-    "indentSize": 2,
-    "lineWidth": 100
-  },
-  "javascript": {
-    "formatter": {
-      "quoteStyle": "single"
-    }
-  },
-  "linter": {
-    "enabled": false
-  }
-}

package/template-admin-server/src/config/config.default.ts

@@ -1,56 +0,0 @@
-/*
- * @Author: zhangyang
- * @Date: 2022-12-27 10:56:45
- * @LastEditTime: 2023-01-09 15:14:11
- * @Description:
- */
-import { MidwayAppInfo, MidwayConfig } from '@midwayjs/core';
-import * as Entities from '../entities';
-
-export default (appInfo: MidwayAppInfo): MidwayConfig => {
-  const SERCRET_KEY = 'bluesyoung_web';
-  return {
-    // 用于对 cookie 进行签名
-    keys: SERCRET_KEY,
-    koa: {
-      port: +process.env.LISTEN_PORT || 7001,
-      globalPrefix: '/api',
-    },
-    typeorm: {
-      dataSource: {
-        default: {
-          type: 'mysql',
-          // 以下为 MySQL 配置
-          username: 'root',
-          password: 'root',
-          port: 3306,
-          database: 'dev_music',
-          charset: 'utf8mb4',
-          // 生产环境，不同步数据库表结构
-          synchronize: process.env.NODE_ENV !== 'production',
-          logging: false,
-          entities: Object.values(Entities),
-        },
-      },
-    },
-    jwt: {
-      secret: SERCRET_KEY,
-      /**
-       * 过期时间，秒
-       */
-      expiresIn: 60 * 60 * 24,
-    },
-    passport: {
-      /**
-       * 不序列化到 session
-       */
-      session: false,
-    },
-    validate: {
-      validationOptions: {
-        // 允许传递未定义的参数
-        allowUnknown: true,
-      },
-    },
-  };
-};

package/template-admin-server/src/configuration.ts

@@ -1,47 +0,0 @@
-/*
- * @Author: zhangyang
- * @Date: 2022-12-27 11:02:18
- * @LastEditTime: 2023-01-09 15:05:25
- * @Description:
- */
-import { Configuration, App } from '@midwayjs/decorator';
-import * as koa from '@midwayjs/koa';
-import * as validate from '@midwayjs/validate';
-import * as info from '@midwayjs/info';
-import * as orm from '@midwayjs/typeorm';
-import * as passport from '@midwayjs/passport';
-import * as jwt from '@midwayjs/jwt';
-import * as cache from '@midwayjs/cache';
-import { join } from 'path';
-// import { DefaultErrorFilter } from './filter/default.filter';
-// import { NotFoundFilter } from './filter/notfound.filter';
-import { ReportMiddleware, HelperMiddleware, JwtPassportMiddleware } from './middleware';
-
-@Configuration({
-  imports: [
-    koa,
-    orm,
-    jwt,
-    passport,
-    validate,
-    {
-      // 环境探测，类似于 php-info，仅 dev 模式启用
-      // 访问 /_info 可以查看
-      component: info,
-      enabledEnvironment: ['local'],
-    },
-    cache
-  ],
-  importConfigs: [join(__dirname, './config')],
-})
-export class ContainerLifeCycle {
-  @App()
-  app: koa.Application;
-
-  async onReady() {
-    // add middleware
-    this.app.useMiddleware([ReportMiddleware, HelperMiddleware, JwtPassportMiddleware]);
-    // add filter
-    // this.app.useFilter([NotFoundFilter, DefaultErrorFilter]);
-  }
-}