cool-admin-midway/README.md at 1783e717f76d853d124c5b47bbc6a00d8a5c37b8

mirroring/cool-admin-midway

Fork 0

mirror of https://github.com/cool-team-official/cool-admin-midway.git synced 2024-11-01 14:10:29 +08:00

COOL 40eddb734b

Update README.md

2024-08-06 17:28:20 +08:00

6.2 KiB

Raw Blame History

cool-admin(midway版)一个很酷的后台权限管理系统，开源免费，模块化、插件化、极速开发CRUD，方便快速构建迭代后台管理系统，支持serverless、docker、普通服务器等多种方式部署到官网进一步了解。

GitHub tag

特性

Ai时代，很多老旧的框架已经无法满足现代化的开发需求，Cool-Admin开发了一系列的功能，让开发变得更简单、更快速、更高效。

Ai编码：通过微调大模型学习框架特有写法，实现简单功能从Api接口到前端页面的一键生成
流程编排：通过拖拽编排方式，即可实现类似像智能客服这样的功能
模块化：代码是模块化的，清晰明了，方便维护
插件化：插件化的设计，可以通过安装插件的方式扩展如：支付、短信、邮件等功能

技术栈

后端：node.js midway.js koa.js typescript
前端：vue.js element-plus jsx pinia vue-router
数据库：mysql postgresql sqlite

如果你是前端，后端的这些技术选型对你是特别友好的，前端开发者可以较快速地上手。如果你是后端，Typescript 的语法又跟 java、php 等特别类似，一切看起来也是那么得熟悉。

如果你想使用 java 版本后端，请移步cool-admin-java

官网

https://cool-js.com

视频教程

官方 B 站视频教程

演示

AI 极速编码

https://show.cool-admin.com

账户：admin
密码：123456

Admin Home

项目前端

https://github.com/cool-team-official/cool-admin-vue

或

https://gitee.com/cool-team-official/cool-admin-vue

或

https://gitcode.com/cool_team/cool-admin-vue

微信群

Admin Wechat

运行

修改数据库配置，配置文件位于`src/config/config.local.ts`

以 Mysql 为例，其他数据库请参考数据库配置文档

Mysql(>=5.7版本)，建议 8.0，node 版本(>=16.x)，建议 18.x，首次启动会自动初始化并导入数据

// mysql，驱动已经内置，无需安装
typeorm: {
    dataSource: {
      default: {
        type: 'mysql',
        host: '127.0.0.1',
        port: 3306,
        username: 'root',
        password: '123456',
        database: 'cool',
        // 自动建表 注意：线上部署的时候不要使用，有可能导致数据丢失
        synchronize: true,
        // 打印日志
        logging: false,
        // 字符集
        charset: 'utf8mb4',
        // 是否开启缓存
        cache: true,
        // 实体路径
        entities: ['**/modules/*/entity'],
      },
    },
  },

安装依赖并运行

$ npm i
$ npm run dev
$ open http://localhost:8001/

注： npm i如果安装失败可以尝试使用cnpm，或者切换您的镜像源，推荐使用pnpm

CURD(快速增删改查)

大部分的后台管理系统，或者 API 服务都是对数据进行管理，所以可以看到大量的 CRUD 场景(增删改查)，cool-admin 对此进行了大量地封装，让这块的编码量变得极其地少。

新建一个数据表

src/modules/demo/entity/goods.ts，项目启动数据库会自动创建该表，无需手动创建

import { BaseEntity } from '@cool-midway/core';
import { Column, Entity, Index } from 'typeorm';

/**
 * 商品
 */
@Entity('demo_app_goods')
export class DemoAppGoodsEntity extends BaseEntity {
  @Column({ comment: '标题' })
  title: string;

  @Column({ comment: '图片' })
  pic: string;

  @Column({ comment: '价格', type: 'decimal', precision: 5, scale: 2 })
  price: number;
}

编写 api 接口

src/modules/demo/controller/app/goods.ts，快速编写 6 个 api 接口

import { CoolController, BaseController } from '@cool-midway/core';
import { DemoAppGoodsEntity } from '../../entity/goods';

/**
 * 商品
 */
@CoolController({
  api: ['add', 'delete', 'update', 'info', 'list', 'page'],
  entity: DemoAppGoodsEntity,
})
export class DemoAppGoodsController extends BaseController {
  /**
   * 其他接口
   */
  @Get('/other')
  async other() {
    return this.ok('hello, cool-admin!!!');
  }
}

这样我们就完成了 6 个接口的编写，对应的接口如下：

POST /app/demo/goods/add 新增
POST /app/demo/goods/delete 删除
POST /app/demo/goods/update 更新
GET /app/demo/goods/info 单个信息
POST /app/demo/goods/list 列表信息
POST /app/demo/goods/page 分页查询(包含模糊查询、字段全匹配等)

部署

部署教程

内置指令

使用 npm run lint 来做代码风格检查。

低价服务器

阿里云、腾讯云、华为云低价云服务器，不限新老

6.2 KiB Raw Blame History Unescape Escape

特性

技术栈

官网