[2023-09-01] init project and finish basic layout

plantree · Sep 1, 2023 · e76fba3 · e76fba3
1 parent ebce859
commit e76fba3
Show file tree

Hide file tree

Showing 38 changed files with 4,860 additions and 0 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,3 @@
+dist
+src/assets
+public
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,29 @@
+{
+  "root": true,
+  "globals": {
+    "__VERSION__": "readonly"
+  },
+  "parser": "vue-eslint-parser",
+  "parserOptions": {
+    "parser": "@typescript-eslint/parser",
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint", "prettier", "vue"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "plugin:vue/vue3-recommended"
+  ],
+  "rules": {
+    "no-console": 1, // Means warning
+    "prettier/prettier": 2, // Means error
+    "vue/multi-word-component-names": 0,
+    "vue/no-v-html": 0,
+    "vue/html-self-closing": 0,
+    "vue/max-attributes-per-line": 0,
+    "vue/singleline-html-element-content-newline": 0
+  }
+}
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+pnpm run lint-staged
diff --git a/.lintstagedrc.cjs b/.lintstagedrc.cjs
@@ -0,0 +1,5 @@
+module.exports = {
+  '*.{vue,js,jsx,ts,tsx}': 'eslint --fix',
+  '*.{vue,css,less,scss}': 'stylelint --fix',
+  '*.{md,json,html}': 'prettier --write'
+};
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+node_modules
+dist
+src/assets
+public
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none"
+}
diff --git a/.stylelintrc.cjs b/.stylelintrc.cjs
@@ -0,0 +1,33 @@
+module.exports = {
+  extends: ['stylelint-config-recommended'],
+
+  plugins: ['stylelint-scss', 'stylelint-order'],
+
+  rules: {
+    'at-rule-no-unknown': null,
+    'no-irregular-whitespace': null,
+    'scss/at-rule-no-unknown': [
+      true,
+      {
+        ignoreAtRules: ['tailwind']
+      }
+    ],
+    'font-family-no-missing-generic-family-keyword': [
+      true,
+      { ignoreFontFamilies: ['Fallback'] }
+    ],
+    'selector-pseudo-class-no-unknown': [
+      true,
+      { ignorePseudoClasses: ['deep'] }
+    ]
+  },
+
+  ignoreFiles: ['dist/**/*.css'],
+
+  overrides: [
+    {
+      files: ['**/*.vue'],
+      customSyntax: 'postcss-html'
+    }
+  ]
+};
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,4 @@
+{
+  "eslint.validate": ["javascript", "typescript", "vue"],
+  "editor.formatOnSave": true
+}
diff --git a/README-zh.md b/README-zh.md
@@ -0,0 +1,3 @@
+# ocr-pwa
+
+A simple PWA for OCR, based on Tesseract.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
 # ocr-pwa
+
 A simple PWA for OCR, based on Tesseract.
+
+## Preview
+
+## Introduction
+
+## Features
+
+## Resources
+
+## Issues
+
+## License
+
+[MIT](https://opensource.org/licenses/MIT)
+
+Copyright (c) 2023-present, Plantree
+
+- https://daisyui.com/docs/install/
+- https://vitejs.dev/
+- https://vuejs.org/
diff --git a/docs/en-US/guide.md b/docs/en-US/guide.md
diff --git a/docs/zh-CN/guide.md b/docs/zh-CN/guide.md
diff --git a/index.html b/index.html
@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="zh-CN">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>We OCR</title>
+  </head>
+
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/package.json b/package.json
@@ -0,0 +1,46 @@
+{
+  "name": "ocr-pwa",
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "lint": "eslint ./src --ext .js,.jsx,.ts,.tsx,.vue --fix",
+    "format": "prettier --config .prettierrc src/**/*{.ts,.vue} --write",
+    "stylelint": "stylelint  ./src/**/*.{scss,css,less,vue} --fix",
+    "lint-staged": "lint-staged",
+    "dev": "vite",
+    "build": "vue-tsc && vite build",
+    "preview": "vite preview",
+    "prepare": "husky install"
+  },
+  "dependencies": {
+    "vue": "^3.3.4",
+    "vue-i18n": "9",
+    "vue-router": "4"
+  },
+  "devDependencies": {
+    "@types/node": "^20.5.7",
+    "@typescript-eslint/eslint-plugin": "^6.5.0",
+    "@typescript-eslint/parser": "^6.4.1",
+    "@vitejs/plugin-vue": "^4.2.3",
+    "autoprefixer": "^10.4.15",
+    "daisyui": "^3.6.3",
+    "eslint": "^8.48.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-vue": "^9.17.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^14.0.1",
+    "naive-ui": "^2.34.4",
+    "postcss": "^8.4.28",
+    "postcss-html": "^1.5.0",
+    "prettier": "^3.0.2",
+    "stylelint": "^15.10.3",
+    "stylelint-config-standard": "^34.0.0",
+    "stylelint-order": "^6.0.3",
+    "stylelint-scss": "^5.1.0",
+    "tailwindcss": "^3.3.3",
+    "typescript": "^5.0.2",
+    "vite": "^4.4.5",
+    "vue-tsc": "^1.8.5"
+  }
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# ocr-pwa

		A simple PWA for OCR, based on Tesseract.