# sherry

**Repository Path**: cike-projects/sherry

## Basic Information

- **Project Name**: sherry
- **Description**: 一个简单的风控规则引擎
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: future
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 2
- **Created**: 2021-06-17
- **Last Updated**: 2023-11-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

= sherry

> 或许已经完成了历史使命，不在继续开发，之后会将其修改成 kotlin 版本

== 介绍

sherry 是风控项目。

== 软件架构


== 计划功能

- [ ] fetcher 开发和配置
  - [x] SQL
  - [ ] MongoDB
  - [ ] Redis
  - [ ] HTTP
- [ ] 风控规则执行功能

== 内部实现相关

=== 全局常量的定义

fetcher 类型全局定义
|===
| 名称 | 可选值 | 意义 | 实现情况
| fetcher | 1 | HTTP |
|  | 2 | SQL |
|  | 3 | Redis |
|  | 4 | MongoDB |
|===

== 安装教程

**0. IDEA 插件安装**

为了简化部分 setter、getter、toString 等模板方法使用了 Lombok，建议安装 Lombok 插件。

**1. 初始化数据库**

[source,sql]
----
create database sherry DEFAULT CHARACTER SET utf8mb4;
----

1. xxxx
2. xxxx
3. xxxx

=== 使用说明

image::docs/index.png[]

1. xxxx
2. xxxx
3. xxxx

==== 参与贡献

1. Fork 本仓库
2. 新建 feature_xxx 分支
3. 提交代码
4. 新建 Pull Request

==== 特技