commit 6de958d5e71511c78df972d3fbffd24688720e52 Author: hucan <951870319@qq.com> Date: Mon May 12 14:55:26 2025 +0800 1 diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3454886 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +# https://editorconfig.org +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 2 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +insert_final_newline = false +trim_trailing_whitespace = false diff --git a/.env.development b/.env.development new file mode 100644 index 0000000..cd7b50c --- /dev/null +++ b/.env.development @@ -0,0 +1,6 @@ +# just a flag +ENV = 'development' + +# base api +VUE_APP_BASE_API = 'http://127.0.0.1:8000' + diff --git a/.env.production b/.env.production new file mode 100644 index 0000000..8994f69 --- /dev/null +++ b/.env.production @@ -0,0 +1,6 @@ +# just a flag +ENV = 'production' + +# base api +VUE_APP_BASE_API = '' + diff --git a/.env.staging b/.env.staging new file mode 100644 index 0000000..097edb1 --- /dev/null +++ b/.env.staging @@ -0,0 +1,8 @@ +NODE_ENV = production + +# just a flag +ENV = 'staging' + +# base api +VUE_APP_BASE_API = '' + diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..e6529fc --- /dev/null +++ b/.eslintignore @@ -0,0 +1,4 @@ +build/*.js +src/assets +public +dist diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 0000000..c977505 --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,198 @@ +module.exports = { + root: true, + parserOptions: { + parser: 'babel-eslint', + sourceType: 'module' + }, + env: { + browser: true, + node: true, + es6: true, + }, + extends: ['plugin:vue/recommended', 'eslint:recommended'], + + // add your custom rules here + //it is base on https://github.com/vuejs/eslint-config-vue + rules: { + "vue/max-attributes-per-line": [2, { + "singleline": 10, + "multiline": { + "max": 1, + "allowFirstLine": false + } + }], + "vue/singleline-html-element-content-newline": "off", + "vue/multiline-html-element-content-newline":"off", + "vue/name-property-casing": ["error", "PascalCase"], + "vue/no-v-html": "off", + 'accessor-pairs': 2, + 'arrow-spacing': [2, { + 'before': true, + 'after': true + }], + 'block-spacing': [2, 'always'], + 'brace-style': [2, '1tbs', { + 'allowSingleLine': true + }], + 'camelcase': [0, { + 'properties': 'always' + }], + 'comma-dangle': [2, 'never'], + 'comma-spacing': [2, { + 'before': false, + 'after': true + }], + 'comma-style': [2, 'last'], + 'constructor-super': 2, + 'curly': [2, 'multi-line'], + 'dot-location': [2, 'property'], + 'eol-last': 2, + 'eqeqeq': ["error", "always", {"null": "ignore"}], + 'generator-star-spacing': [2, { + 'before': true, + 'after': true + }], + 'handle-callback-err': [2, '^(err|error)$'], + 'indent': [2, 2, { + 'SwitchCase': 1 + }], + 'jsx-quotes': [2, 'prefer-single'], + 'key-spacing': [2, { + 'beforeColon': false, + 'afterColon': true + }], + 'keyword-spacing': [2, { + 'before': true, + 'after': true + }], + 'new-cap': [2, { + 'newIsCap': true, + 'capIsNew': false + }], + 'new-parens': 2, + 'no-array-constructor': 2, + 'no-caller': 2, + 'no-console': 'off', + 'no-class-assign': 2, + 'no-cond-assign': 2, + 'no-const-assign': 2, + 'no-control-regex': 0, + 'no-delete-var': 2, + 'no-dupe-args': 2, + 'no-dupe-class-members': 2, + 'no-dupe-keys': 2, + 'no-duplicate-case': 2, + 'no-empty-character-class': 2, + 'no-empty-pattern': 2, + 'no-eval': 2, + 'no-ex-assign': 2, + 'no-extend-native': 2, + 'no-extra-bind': 2, + 'no-extra-boolean-cast': 2, + 'no-extra-parens': [2, 'functions'], + 'no-fallthrough': 2, + 'no-floating-decimal': 2, + 'no-func-assign': 2, + 'no-implied-eval': 2, + 'no-inner-declarations': [2, 'functions'], + 'no-invalid-regexp': 2, + 'no-irregular-whitespace': 2, + 'no-iterator': 2, + 'no-label-var': 2, + 'no-labels': [2, { + 'allowLoop': false, + 'allowSwitch': false + }], + 'no-lone-blocks': 2, + 'no-mixed-spaces-and-tabs': 2, + 'no-multi-spaces': 2, + 'no-multi-str': 2, + 'no-multiple-empty-lines': [2, { + 'max': 1 + }], + 'no-native-reassign': 2, + 'no-negated-in-lhs': 2, + 'no-new-object': 2, + 'no-new-require': 2, + 'no-new-symbol': 2, + 'no-new-wrappers': 2, + 'no-obj-calls': 2, + 'no-octal': 2, + 'no-octal-escape': 2, + 'no-path-concat': 2, + 'no-proto': 2, + 'no-redeclare': 2, + 'no-regex-spaces': 2, + 'no-return-assign': [2, 'except-parens'], + 'no-self-assign': 2, + 'no-self-compare': 2, + 'no-sequences': 2, + 'no-shadow-restricted-names': 2, + 'no-spaced-func': 2, + 'no-sparse-arrays': 2, + 'no-this-before-super': 2, + 'no-throw-literal': 2, + 'no-trailing-spaces': 2, + 'no-undef': 2, + 'no-undef-init': 2, + 'no-unexpected-multiline': 2, + 'no-unmodified-loop-condition': 2, + 'no-unneeded-ternary': [2, { + 'defaultAssignment': false + }], + 'no-unreachable': 2, + 'no-unsafe-finally': 2, + 'no-unused-vars': [2, { + 'vars': 'all', + 'args': 'none' + }], + 'no-useless-call': 2, + 'no-useless-computed-key': 2, + 'no-useless-constructor': 2, + 'no-useless-escape': 0, + 'no-whitespace-before-property': 2, + 'no-with': 2, + 'one-var': [2, { + 'initialized': 'never' + }], + 'operator-linebreak': [2, 'after', { + 'overrides': { + '?': 'before', + ':': 'before' + } + }], + 'padded-blocks': [2, 'never'], + 'quotes': [2, 'single', { + 'avoidEscape': true, + 'allowTemplateLiterals': true + }], + 'semi': [2, 'never'], + 'semi-spacing': [2, { + 'before': false, + 'after': true + }], + 'space-before-blocks': [2, 'always'], + 'space-before-function-paren': [2, 'never'], + 'space-in-parens': [2, 'never'], + 'space-infix-ops': 2, + 'space-unary-ops': [2, { + 'words': true, + 'nonwords': false + }], + 'spaced-comment': [2, 'always', { + 'markers': ['global', 'globals', 'eslint', 'eslint-disable', '*package', '!', ','] + }], + 'template-curly-spacing': [2, 'never'], + 'use-isnan': 2, + 'valid-typeof': 2, + 'wrap-iife': [2, 'any'], + 'yield-star-spacing': [2, 'both'], + 'yoda': [2, 'never'], + 'prefer-const': 2, + 'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0, + 'object-curly-spacing': [2, 'always', { + objectsInObjects: false + }], + 'array-bracket-spacing': [2, 'never'] + } +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..78a752d --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ +.DS_Store +node_modules/ +dist/ +npm-debug.log* +yarn-debug.log* +yarn-error.log* +**/*.log + +tests/**/coverage/ +tests/e2e/reports +selenium-debug.log + +# Editor directories and files +.idea +.vscode +*.suo +*.ntvs* +*.njsproj +*.sln +*.local + +package-lock.json +yarn.lock diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..c9a6c1b --- /dev/null +++ b/.npmrc @@ -0,0 +1,4 @@ +sass_binary_site=https://npm.taobao.org/mirrors/node-sass/ +phantomjs_cdnurl=https://npm.taobao.org/mirrors/phantomjs/ +electron_mirror=https://npm.taobao.org/mirrors/electron/ +registry=https://registry.npm.taobao.org diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..f4be7a0 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,5 @@ +language: node_js +node_js: 10 +script: npm run test +notifications: + email: false diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..f5afba8 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +FROM registry.cn-shanghai.aliyuncs.com/lwmeng/node:lts-alpine as build-stage +WORKDIR /app +COPY package*.json ./ +RUN npm install -g cnpm --registry=https://registry.npm.taobao.org +RUN cnpm install +COPY . . +RUN npm run build:prod + +# production stage +FROM registry.cn-shanghai.aliyuncs.com/lwmeng/nginx +COPY --from=build-stage /app/dist /usr/share/nginx/html + +EXPOSE 80 +CMD ["nginx", "-g", "daemon off;"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2e5981c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 wenjianzhang + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.Zh-cn.md b/README.Zh-cn.md new file mode 100644 index 0000000..e4c9266 --- /dev/null +++ b/README.Zh-cn.md @@ -0,0 +1,289 @@ +# go-admin + + + + +[![Build Status](https://github.com/wenjianzhang/go-admin/workflows/build/badge.svg)](https://github.com/go-admin-team/go-admin) +[![Release](https://img.shields.io/github/release/go-admin-team/go-admin.svg?style=flat-square)](https://github.com/go-admin-team/go-admin/releases) +[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/go-admin-team/go-admin) + +[English](https://github.com/go-admin-team/go-admin/blob/master/README.md) | 简体中文 + + +基于Gin + Vue + Element UI的前后端分离权限管理系统,系统初始化极度简单，只需要配置文件中，修改数据库连接，系统支持多指令操作，迁移指令可以让初始化数据库信息变得更简单，服务指令可以很简单的启动api服务 + +[在线文档](https://doc.go-admin.dev) + +[github在线文档](https://wenjianzhang.github.io) + +[gitee在线文档](http://mydearzwj.gitee.io/go-admin-doc/) + +[后端项目](https://github.com/go-admin-team/go-admin) + +[视频教程](https://space.bilibili.com/565616721/channel/detail?cid=125737) + +## ✨ 特性 + +- 遵循 RESTful API 设计规范 + +- 基于 GIN WEB API 框架，提供了丰富的中间件支持（用户认证、跨域、访问日志、追踪ID等） + +- 基于Casbin的 RBAC 访问控制模型 + +- JWT 认证 + +- 支持 Swagger 文档(基于swaggo) + +- 基于 GORM 的数据库存储，可扩展多种类型数据库 + +- 配置文件简单的模型映射，快速能够得到想要的配置 + +- 代码生成工具 + +- 表单构建工具 + +- 多指令模式 + +- TODO: 单元测试 + + +## 🎁 内置 + +1. 用户管理：用户是系统操作者，该功能主要完成系统用户配置。 +2. 部门管理：配置系统组织机构（公司、部门、小组），树结构展现支持数据权限。 +3. 岗位管理：配置系统用户所属担任职务。 +4. 菜单管理：配置系统菜单，操作权限，按钮权限标识，接口权限等。 +5. 角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。 +6. 字典管理：对系统中经常使用的一些较为固定的数据进行维护。 +7. 参数管理：对系统动态配置常用参数。 +8. 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 +9. 登录日志：系统登录日志记录查询包含登录异常。 +1. 接口文档：根据业务代码自动生成相关的api接口文档。 +1. 代码生成：根据数据表结构生成对应的增删改查相对应业务，全程可视化操作，让基本业务可以零代码实现。 +1. 表单构建：自定义页面样式，拖拉拽实现页面布局。 +1. 服务监控：查看一些服务器的基本信息。 +1. 内容管理：demo功能，下设分类管理、内容管理。可以参考使用方便快速入门。 + +## 准备工作 + +你需要在本地安装 [go] [gin] [node](http://nodejs.org/) 和 [git](https://git-scm.com/) + +同时配套了系列教程包含视频和文档，如何从下载完成到熟练使用，强烈建议大家先看完这些教程再来实践本项目！！！ + +### 轻松实现go-admin写出第一个应用 - 文档教程 + +[步骤一 - 基础内容介绍](http://doc.zhangwj.com/go-admin-site/guide/intro/tutorial01.html) + +[步骤二 - 实际应用 - 编写增删改查](http://doc.zhangwj.com/go-admin-site/guide/intro/tutorial02.html) + +### 手把手教你从入门到放弃 - 视频教程 + +[如何启动go-admin](https://www.bilibili.com/video/BV1z5411x7JG) + +[使用生成工具轻松实现业务](https://www.bilibili.com/video/BV1Dg4y1i79D) + +[v1.1.0版本代码生成工具-释放双手](https://www.bilibili.com/video/BV1N54y1i71P) [进阶] + +[多命令启动方式讲解以及IDE配置](https://www.bilibili.com/video/BV1Fg4y1q7ph) + +[go-admin菜单的配置说明](https://www.bilibili.com/video/BV1Wp4y1D715) [必看] + +[如何配置菜单信息以及接口信息](https://www.bilibili.com/video/BV1zv411B7nG) [必看] + +[go-admin权限配置使用说明](https://www.bilibili.com/video/BV1rt4y197d3) [必看] + +[go-admin数据权限使用说明](https://www.bilibili.com/video/BV1LK4y1s71e) [必看] + + +**如有问题请先看上述使用文档和文章，若不能满足，欢迎 issue 和 pr ，视频教程和文档持续更新中** + +## 📦 本地开发 + +### 开发目录创建 + +```bash + +# 创建开发目录 +mkdir goadmin +cd goadmin +``` + +### 获取代码 + +> 重点注意：两个项目必须放在同一文件夹下； + +```bash +# 获取后端代码 +git clone https://github.com/go-admin-team/go-admin.git + +# 获取前端代码 +git clone https://github.com/go-admin-team/go-admin-ui.git + +``` + + +### 启动说明 + +#### 服务端启动说明 + +```bash +# 进入 go-admin 后端项目 +cd ./go-admin + +# 编译项目 +go build + +# 修改配置 +# 文件路径 go-admin/config/settings.yml +vi ./config/setting.yml + +# 1. 配置文件中修改数据库信息 +# 注意: settings.database 下对应的配置数据 +# 2. 确认log路径 +``` + +:::tip ⚠️注意 在windows环境如果没有安装中CGO，会出现这个问题； + +```bash +E:\go-admin>go build +# github.com/mattn/go-sqlite3 +cgo: exec /missing-cc: exec: "/missing-cc": file does not exist +``` + +or + +```bash +D:\Code\go-admin>go build +# github.com/mattn/go-sqlite3 +cgo: exec gcc: exec: "gcc": executable file not found in %PATH% +``` + +[解决cgo问题进入](https://doc.go-admin.dev/guide/other/faq.html#_5-cgo-exec-missing-cc-exec-missing-cc-file-does-not-exist) + +::: + +#### 初始化数据库，以及服务启动 + +``` bash +# 首次配置需要初始化数据库资源信息 +# macOS or linux 下使用 +$ ./go-admin migrate -c=config/settings.dev.yml + +# ⚠️注意:windows 下使用 +$ go-admin.exe migrate -c=config/settings.dev.yml + + +# 启动项目，也可以用IDE进行调试 +# macOS or linux 下使用 +$ ./go-admin server -c config/settings.yml + + +# ⚠️注意:windows 下使用 +$ go-admin.exe server -c config/settings.yml +``` + +#### 使用docker 编译启动 + +```shell +# 编译镜像 +docker build -t go-admin . + +# 启动容器，第一个go-admin是容器名字，第二个go-admin是镜像名称 +# -v 映射配置文件 本地路径：容器路径 +docker run --name go-admin -p 8000:8000 -v /config/settings.yml:/config/settings.yml -d go-admin-server +``` + + + +#### 文档生成 + +```bash +go generate +``` + +#### 交叉编译 +```bash +# windows +env GOOS=windows GOARCH=amd64 go build main.go + +# or +# linux +env GOOS=linux GOARCH=amd64 go build main.go +``` + +### UI交互端启动说明 + +```bash +# 安装依赖 +npm install + +# 建议不要直接使用 cnpm 安装依赖，会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题 +npm install --registry=https://registry.npm.taobao.org + +# 启动服务 +npm run dev +``` + +## 🎬 在线体验 +> admin / 123456 + +演示地址：[http://www.go-admin.dev](http://www.go-admin.dev/#/login) + + +## 📨 互动 + + + + + + + + + + + + +
微信此群已满go-admin技术交流乙号
+ +## 💎 主要成员 + + + + + + + + +## JetBrains 开源证书支持 + +`go-admin` 项目一直以来都是在 JetBrains 公司旗下的 GoLand 集成开发环境中进行开发，基于 **free JetBrains Open Source license(s)** 正版免费授权，在此表达我的谢意。 + + + + +## 🤝 特别感谢 +1. [chengxiao](https://github.com/chengxiao) +2. [gin](https://github.com/gin-gonic/gin) +2. [casbin](https://github.com/casbin/casbin) +2. [spf13/viper](https://github.com/spf13/viper) +2. [gorm](https://github.com/jinzhu/gorm) +2. [gin-swagger](https://github.com/swaggo/gin-swagger) +2. [jwt-go](https://github.com/dgrijalva/jwt-go) +2. [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin) +2. [ruoyi-vue](https://gitee.com/y_project/RuoYi-Vue) +2. [form-generator](https://github.com/JakHuang/form-generator) + +## 🤟 打赏 + +> 如果你觉得这个项目帮助到了你，你可以帮作者买一杯果汁表示鼓励 :tropical_drink: + + + +## 🤝 链接 +[Go开发者成长线路图](http://www.golangroadmap.com/) + +## 🔑 License + +[MIT](https://github.com/go-admin-team/go-admin/blob/master/LICENSE.md) + +Copyright (c) 2020 wenjianzhang \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..5c0c61a --- /dev/null +++ b/README.md @@ -0,0 +1,276 @@ +# go-admin + + + + +[![Build Status](https://github.com/wenjianzhang/go-admin/workflows/build/badge.svg)](https://github.com/go-admin-team/go-admin) +[![Release](https://img.shields.io/github/release/go-admin-team/go-admin.svg?style=flat-square)](https://github.com/go-admin-team/go-admin/releases) +[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/go-admin-team/go-admin) + +English | [简体中文](https://github.com/go-admin-team/go-admin/blob/master/README.Zh-cn.md) + +The front-end and back-end separation authority management system based on Gin + Vue + Element UI is extremely simple to initialize the system. You only need to modify the database connection in the configuration file. The system supports multi-instruction operations. Migration instructions can make it easier to initialize database information. Service instructions It's easy to start the api service. + +[documentation](https://doc.go-admin.dev) + +[Backend project](https://github.com/go-admin-team/go-admin) + +[Video tutorial](https://space.bilibili.com/565616721/channel/detail?cid=125737) + +## ✨ Feature + +- Follow RESTful API design specifications + +- Based on the GIN WEB API framework, it provides rich middleware support (user authentication, cross-domain, access log, tracking ID, etc.) + +- RBAC access control model based on Casbin + +- JWT authentication + +- Support Swagger documents (based on swaggo) + +- Database storage based on GORM, which can expand multiple types of databases + +- Simple model mapping of configuration files to quickly get the desired configuration + +- Code generation tool + +- Form builder + +- Multi-command mode + +- TODO: unit test + + +## 🎁 Internal + +1. User management: The user is the system operator, this function mainly completes the system user configuration. +2. Department management: configure the system organization (company, department, group), and display the tree structure to support data permissions. +3. Position management: configure the positions of system users. +4. Menu management: configure the system menu, operation authority, button authority identification, interface authority, etc. +5. Role management: Role menu permission assignment and role setting are divided into data scope permissions by organization. +6. Dictionary management: Maintain some relatively fixed data frequently used in the system. +7. Parameter management: dynamically configure common parameters for the system. +8. Operation log: system normal operation log record and query; system abnormal information log record and query. +9. Login log: The system login log record query contains login exceptions. +1. Interface documentation: Automatically generate related api interface documents according to the business code. +1. Code generation: According to the data table structure, generate the corresponding addition, deletion, modification, and check corresponding business, and the whole process of visual operation, so that the basic business can be implemented with zero code. +1. Form construction: Customize the page style, drag and drop to realize the page layout. +1. Service monitoring: View the basic information of some servers. +1. Content management: demo function, including classification management and content management. You can refer to the easy to use quick start. + +## Ready to work + +You need to install locally [go] [gin] [node](http://nodejs.org/) 和 [git](https://git-scm.com/) + +At the same time, a series of tutorials including videos and documents are provided. How to complete the downloading to the proficient use, it is strongly recommended that you read these tutorials before you practice this project! ! ! + +### Easily implement go-admin to write the first application-documentation tutorial + +[Step 1 - basic content introduction](http://doc.zhangwj.com/go-admin-site/guide/intro/tutorial01.html) + +[Step 2 - Practical application - writing database operations](http://doc.zhangwj.com/go-admin-site/guide/intro/tutorial02.html) + +### Teach you from getting started to giving up-video tutorial + +[How to start go-admin](https://www.bilibili.com/video/BV1z5411x7JG) + +[Easily implement business using build tools](https://www.bilibili.com/video/BV1Dg4y1i79D) + +[v1.1.0 version code generation tool-free your hands](https://www.bilibili.com/video/BV1N54y1i71P) [Advanced] + +[Explanation of multi-command startup mode and IDE configuration](https://www.bilibili.com/video/BV1Fg4y1q7ph) + +[Configuration instructions for go-admin menu](https://www.bilibili.com/video/BV1Wp4y1D715) [Must see] + +[How to configure menu information and interface information](https://www.bilibili.com/video/BV1zv411B7nG) [Must see] + +[go-admin permission configuration instructions](https://www.bilibili.com/video/BV1rt4y197d3) [Must see] + +[Instructions for use of go-admin data permissions](https://www.bilibili.com/video/BV1LK4y1s71e) [Must see] + +**If you have any questions, please read the above-mentioned usage documents and articles first. If you are not satisfied, welcome to issue and pr. Video tutorials and documents are being updated continuously.** + +## 📦 Local development + +### Development directory creation + +```bash + +# Create a development directory +mkdir goadmin +cd goadmin +``` + +### Get the code + +> Important note: the two projects must be placed in the same folder; + +```bash +# Get backend code +git clone https://github.com/go-admin-team/go-admin.git + +# Get the front-end code +git clone https://github.com/go-admin-team/go-admin-ui.git + +``` + +### Startup instructions + +#### Server startup instructions + +```bash +# Enter the go-admin backend project +cd ./go-admin + +# Compile the project +go build + +# Change setting +# File path go-admin/config/settings.yml +vi ./config/setting.yml + +# 1. Modify the database information in the configuration file +# Note: The corresponding configuration data under settings.database +# 2. Confirm the log path +``` + +:::tip ⚠️Note that this problem will occur if CGO is not installed in the windows environment; + +```bash +E:\go-admin>go build +# github.com/mattn/go-sqlite3 +cgo: exec /missing-cc: exec: "/missing-cc": file does not exist +``` + +or + +```bash +D:\Code\go-admin>go build +# github.com/mattn/go-sqlite3 +cgo: exec gcc: exec: "gcc": executable file not found in %PATH% +``` + +[Solve the cgo problem and enter](https://doc.go-admin.dev/guide/other/faq.html#_5-cgo-exec-missing-cc-exec-missing-cc-file-does-not-exist) + +::: + +#### Initialize the database, and start the service + +``` bash +# The first configuration needs to initialize the database resource information +# Use under macOS or linux +$ ./go-admin migrate -c=config/settings.dev.yml + +# ⚠️Note: Use under windows +$ go-admin.exe migrate -c=config/settings.dev.yml + +# Start the project, you can also use the IDE for debugging +# Use under macOS or linux +$ ./go-admin server -c config/settings.yml + +# ⚠️Note: Use under windows +$ go-admin.exe server -c config/settings.yml +``` + +#### Use docker to compile and start + +```shell +# Compile the image +docker build -t go-admin . + + +# Start the container, the first go-admin is the container name, and the second go-admin is the image name +# -v Mapping configuration file Local path: container path +docker run --name go-admin -p 8000:8000 -v /config/settings.yml:/config/settings.yml -d go-admin-server +``` + + + +#### Generation Document + +```bash +go generate +``` + +#### Cross compile +```bash +# windows +env GOOS=windows GOARCH=amd64 go build main.go + +# or +# linux +env GOOS=linux GOARCH=amd64 go build main.go +``` + +### UI interactive terminal startup instructions + +```bash +# Installation dependencies +npm install # or cnpm install + +# Start service +npm run dev +``` + +## 🎬 Online Demo +> admin / 123456 + +演示地址：[http://www.go-admin.dev](http://www.go-admin.dev/#/login) + + +## 📨 Interactive + + + + + + + + + + +
Wechatgo-admin技术交流乙号
+ +## 💎 Members + + + + + + + + +## JetBrains open source certificate support + +The `go-admin` project has always been developed in the GoLand integrated development environment under JetBrains, based on the **free JetBrains Open Source license(s)** genuine free license. I would like to express my gratitude. + + + + +## 🤝 Thanks +1. [chengxiao](https://github.com/chengxiao) +2. [gin](https://github.com/gin-gonic/gin) +2. [casbin](https://github.com/casbin/casbin) +2. [spf13/viper](https://github.com/spf13/viper) +2. [gorm](https://github.com/jinzhu/gorm) +2. [gin-swagger](https://github.com/swaggo/gin-swagger) +2. [jwt-go](https://github.com/dgrijalva/jwt-go) +2. [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin) +2. [ruoyi-vue](https://gitee.com/y_project/RuoYi-Vue) +2. [form-generator](https://github.com/JakHuang/form-generator) + +## 🤟 Sponsor Us + +> If you think this project helped you, you can buy a glass of juice for the author to show encouragement :tropical_drink: + + + +## 🤝 Link +[Go developer growth roadmap](http://www.golangroadmap.com/) + +## 🔑 License + +[MIT](https://github.com/go-admin-team/go-admin/blob/master/LICENSE.md) + +Copyright (c) 2020 wenjianzhang \ No newline at end of file diff --git a/babel.config.js b/babel.config.js new file mode 100644 index 0000000..34be5d7 --- /dev/null +++ b/babel.config.js @@ -0,0 +1,10 @@ +module.exports = { + presets: [ + '@vue/cli-plugin-babel/preset' + ], + env: { + development: { + plugins: ['dynamic-import-node'] + } + } +} diff --git a/build/index.js b/build/index.js new file mode 100644 index 0000000..0c57de2 --- /dev/null +++ b/build/index.js @@ -0,0 +1,35 @@ +const { run } = require('runjs') +const chalk = require('chalk') +const config = require('../vue.config.js') +const rawArgv = process.argv.slice(2) +const args = rawArgv.join(' ') + +if (process.env.npm_config_preview || rawArgv.includes('--preview')) { + const report = rawArgv.includes('--report') + + run(`vue-cli-service build ${args}`) + + const port = 9526 + const publicPath = config.publicPath + + var connect = require('connect') + var serveStatic = require('serve-static') + const app = connect() + + app.use( + publicPath, + serveStatic('./dist', { + index: ['index.html', '/'] + }) + ) + + app.listen(port, function () { + console.log(chalk.green(`> Preview at http://localhost:${port}${publicPath}`)) + if (report) { + console.log(chalk.green(`> Report at http://localhost:${port}${publicPath}report.html`)) + } + + }) +} else { + run(`vue-cli-service build ${args}`) +} diff --git a/jest.config.js b/jest.config.js new file mode 100644 index 0000000..143cdc8 --- /dev/null +++ b/jest.config.js @@ -0,0 +1,24 @@ +module.exports = { + moduleFileExtensions: ['js', 'jsx', 'json', 'vue'], + transform: { + '^.+\\.vue$': 'vue-jest', + '.+\\.(css|styl|less|sass|scss|svg|png|jpg|ttf|woff|woff2)$': + 'jest-transform-stub', + '^.+\\.jsx?$': 'babel-jest' + }, + moduleNameMapper: { + '^@/(.*)$': '/src/$1' + }, + snapshotSerializers: ['jest-serializer-vue'], + testMatch: [ + '**/tests/unit/**/*.spec.(js|jsx|ts|tsx)|**/__tests__/*.(js|jsx|ts|tsx)' + ], + collectCoverageFrom: ['src/utils/**/*.{js,vue}', '!src/utils/auth.js', '!src/utils/request.js', 'src/components/**/*.{js,vue}'], + coverageDirectory: '/tests/unit/coverage', + // 'collectCoverage': true, + 'coverageReporters': [ + 'lcov', + 'text-summary' + ], + testURL: 'http://localhost/' +} diff --git a/jsconfig.json b/jsconfig.json new file mode 100644 index 0000000..958df04 --- /dev/null +++ b/jsconfig.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "baseUrl": "./", + "paths": { + "@/*": ["src/*"] + } + }, + "exclude": ["node_modules", "dist"] +} \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..76d273c --- /dev/null +++ b/package.json @@ -0,0 +1,138 @@ +{ + "name": "go-admin", + "version": "2.0.6", + "description": "A magical vue admin. An out-of-box UI solution for enterprise applications. Newest development stack of vue. Lots of awesome features", + "author": "https://github.com/wenjianzhang", + "license": "MIT", + "scripts": { + "dev": "vue-cli-service serve", + "build:prod": "vue-cli-service build", + "build:stage": "vue-cli-service build --mode staging", + "preview": "node build/index.js --preview", + "lint": "eslint --ext .js,.vue src", + "test:unit": "jest --clearCache && vue-cli-service test:unit", + "test:ci": "npm run lint && npm run test:unit", + "svgo": "svgo -f src/icons/svg --config=src/icons/svgo.yml", + "new": "plop" + }, + "husky": { + "hooks": { + "pre-commit": "lint-staged" + } + }, + "lint-staged": { + "src/**/*.{js,vue}": [ + "eslint --fix", + "git add" + ] + }, + "keywords": [ + "vue", + "admin", + "go-admin", + "go-admin-ui", + "dashboard", + "element-ui", + "boilerplate", + "admin-template", + "management-system" + ], + "repository": { + "type": "git", + "url": "git+https://github.com/go-admin-team/go-admin.git" + }, + "bugs": { + "url": "https://github.com/go-admin-team/go-admin/issues" + }, + "dependencies": { + "@riophae/vue-treeselect": "0.4.0", + "@tinymce/tinymce-vue": "^3.2.2", + "awe-dnd": "^0.3.4", + "axios": "0.21.1", + "clipboard": "2.0.6", + "codemirror": "5.62.0", + "core-js": "^3.6.5", + "driver.js": "0.9.8", + "dropzone": "5.7.2", + "echarts": "4.8.0", + "element-ui": "2.13.2", + "file-saver": "2.0.2", + "fuse.js": "6.4.1", + "js-cookie": "2.2.1", + "jsonlint": "1.6.3", + "jszip": "3.5.0", + "moment": "^2.27.0", + "monaco-editor": "^0.20.0", + "normalize.css": "8.0.1", + "nprogress": "0.2.0", + "path-to-regexp": "6.1.0", + "remixicon": "^2.5.0", + "sass-resources-loader": "^2.0.3", + "screenfull": "5.0.2", + "showdown": "^1.9.1", + "solarlunar": "^2.0.7", + "sortablejs": "^1.10.2", + "uuid": "^8.3.0", + "viser-vue": "^2.4.8", + "vue": "2.6.11", + "vue-codemirror": "^4.0.6", + "vue-count-to": "1.0.13", + "vue-cropper": "^0.5.5", + "vue-particles": "^1.0.9", + "vue-quill-editor": "^3.0.6", + "vue-router": "3.4.7", + "vue-splitpane": "1.0.6", + "vuedraggable": "2.24.0", + "vuex": "3.5.1", + "webpack-bundle-analyzer": "^3.8.0", + "xlsx": "0.16.5" + }, + "devDependencies": { + "@babel/core": "7.11.1", + "@babel/register": "^7.10.5", + "@babel/runtime": "^7.12.1", + "@vue/babel-preset-app": "^4.5.7", + "@vue/cli-plugin-babel": "4.4.6", + "@vue/cli-plugin-eslint": "^4.4.6", + "@vue/cli-plugin-unit-jest": "4.4.6", + "@vue/cli-service": "^4.5.13", + "@vue/test-utils": "1.0.3", + "autoprefixer": "^9.8.6", + "babel-core": "7.0.0-bridge.0", + "babel-eslint": "10.1.0", + "babel-jest": "26.2.2", + "babel-plugin-dynamic-import-node": "^2.3.3", + "beautifier": "^0.1.7", + "chalk": "4.1.0", + "chokidar": "3.4.2", + "compression-webpack-plugin": "^4.0.0", + "connect": "3.7.0", + "eslint": "7.6.0", + "eslint-plugin-vue": "6.2.2", + "form-gen-parser": "^1.0.3", + "html-webpack-plugin": "4.3.0", + "husky": "4.2.5", + "lint-staged": "10.2.11", + "mockjs": "1.1.0", + "monaco-editor-webpack-plugin": "^1.9.0", + "plop": "2.7.4", + "runjs": "^4.4.2", + "sass": "^1.35.1", + "sass-loader": "^9.0.3", + "script-ext-html-webpack-plugin": "2.1.4", + "script-loader": "0.7.2", + "serve-static": "^1.14.1", + "svg-sprite-loader": "^5.0.0", + "svgo": "1.3.2", + "vue-quill-editor": "^3.0.6", + "vue-template-compiler": "2.6.11" + }, + "engines": { + "node": ">=8.9", + "npm": ">= 3.0.0" + }, + "browserslist": [ + "> 1%", + "last 2 versions" + ] +} diff --git a/plop-templates/component/index.hbs b/plop-templates/component/index.hbs new file mode 100644 index 0000000..7661055 --- /dev/null +++ b/plop-templates/component/index.hbs @@ -0,0 +1,26 @@ +{{#if template}} + +{{/if}} + +{{#if script}} + +{{/if}} + +{{#if style}} + +{{/if}} diff --git a/plop-templates/component/prompt.js b/plop-templates/component/prompt.js new file mode 100644 index 0000000..3723e8e --- /dev/null +++ b/plop-templates/component/prompt.js @@ -0,0 +1,55 @@ +const { notEmpty } = require('../utils.js') + +module.exports = { + description: 'generate vue component', + prompts: [{ + type: 'input', + name: 'name', + message: 'component name please', + validate: notEmpty('name') + }, + { + type: 'checkbox', + name: 'blocks', + message: 'Blocks:', + choices: [{ + name: '