Skip to content

Commit

Permalink
Docs: add readme default en and add chines readme
Browse files Browse the repository at this point in the history
  • Loading branch information
harlee-x committed Apr 3, 2024
1 parent 120fec4 commit 7db0f9f
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 27 deletions.
59 changes: 35 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,47 @@

# KDP Catalog Manager

## 项目描述
English | [简体中文](./README_zh.md)
<br>

### 项目概述
KDP Catalog Manager是一套大数据应用管理平台。基于应用功能进行分类查看、管理,降低应用管理的复杂度,从而使大数据管理人员更专注于数据的处理
## Project Description

### 核心技术架构
### Project Overview
KDP Catalog Manager is a big data application management platform. It categorizes and manages applications based on their functionalities, reducing the complexity of application management and allowing big data administrators to focus more on data processing.

### Core Technical Architecture
![kdp-catalog-manager](kdp-catalog-manager.png)



### 功能模块描述
### Functional Module Description

#### api
* view
定义 Restful API 并对用户输入参数执行基本验证及结果输出
Defines Restful APIs and performs basic validation on user input parameters and output results.

#### Domain

* service
业务逻辑
Business logic.

* format
数据转换层,用于缓存数据与业务数据转换
Data conversion layer, used for transforming data between cached data and business data.

* model
数据模型实体
Data model entities.



##### Modules
* cache
数据存储层,静态数据存储于缓存中
Data storage layer, where static data is stored in the cache.

* requests
外部数据调用,调用外部服务获取数据
External data invocation, used to call external services to retrieve data.


## 目录结构
## Directory Structure
```shell
├── CODEOWNERS
├── README.md
Expand All @@ -57,39 +65,42 @@ KDP Catalog Manager是一套大数据应用管理平台。基于应用功能进
   └── utils
```

## 启动方式
### 开发环境搭建
* 使用python3.10+
## Startup Procedure

### Development Environment Setup

* Requires Python3.10+


1. 克隆代码至本地
1. Clone the code to your local machine.
```shell
git clone xxx && cd kdp-catalog-manager
```

2. 使用虚拟环境
2. Set up a virtual environment:
```shell
#安装virtualenv
#Install virtualenv
pip install virtualenv
virtualenv -p /usr/local/bin/python3 venv
# 激活虚拟环境
# Activate the virtual environment:
source ./venv/bin/activate

# 关闭虚拟环境
# Deactivate the virtual environment:
deactivate
```

3. 安装依赖
3. Install dependencies:
```shell
pip install -r docker/python/requirements.txt
```

4. 服务启动
4. Start the service:
```shell
cd ~/kdp-catalog-manager \
&& export PYTHONPATH=$PYTHONPATH:$(pwd)
python kdp_catalog_manager/main.py

```

### API 手册
* 启动服务后通过 http://127.0.0.1:8000/docs 查看提供的接口列表
### API Manual
* After starting the service, you can view the list of available endpoints by accessing http://127.0.0.1:8000/docs.
6 changes: 3 additions & 3 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![Tests](https://github.com/linktimecloud/kdp-catalog-manager/actions/workflows/unit-test.yml/badge.svg)
![Build](https://github.com/linktimecloud/kdp-catalog-manager/actions/workflows/ci-build.yml/badge.svg)
![Build](https://github.com/linktimecloud/kdp-catalog-manager/actions/workflows/ci-build.yml/badge.svg)
![](https://img.shields.io/badge/python-3.10.13-green)
![](https://img.shields.io/badge/fastapi-0.110.0-green)
![](https://img.shields.io/badge/fastapi-0.110.0-green)
![image version](https://img.shields.io/docker/v/linktimecloud/kdp-catalog-manager)
![image size](https://img.shields.io/docker/image-size/linktimecloud/kdp-catalog-manager)

Expand Down

0 comments on commit 7db0f9f

Please sign in to comment.