# Kimo

**Repository Path**: chencyhyy/Kimo

## Basic Information

- **Project Name**: Kimo
- **Description**: A Lightweight Flask-Based Backend Blog System|轻量化Flask博客系统
- **Primary Language**: HTML
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-01-14
- **Last Updated**: 2026-02-09

## Categories & Tags

**Categories**: blog

**Tags**: None

## README

<div align="center">

# Kimo

![Python](https://img.shields.io/badge/Python-3.7+-blue)
![Flask](https://img.shields.io/badge/Flask-Latest-green)
![License](https://img.shields.io/badge/License-MIT-yellow)

**A Lightweight Flask-Based Backend Blog System**

English | [简体中文](./README.zh.md)

</div>

---

## ✨ Project Overview

Kimo is a lightweight blog backend system built with the Flask framework. It provides simple and easy-to-use blog content management and user account management features, making it suitable for personal blogs, team knowledge bases, and similar use cases.

## 🎯 Core Features

- ✅ **Blog Management**: Publish, browse, and manage blog posts
- ✅ **User Authentication**: User registration and login
- ✅ **Data Persistence**: MySQL-based data storage
- ✅ **Modular Architecture**: Code organized using Flask Blueprints
- ✅ **Database Connection Pool**: Efficient database connection management via DBUtils

## 🛠️ Tech Stack

| Technology          | Description       |
|---------------------|-------------------|
| **Backend**         | Flask 2.x         |
| **Database**        | MySQL 5.7+        |
| **ORM / Query**     | Raw SQL + PyMySQL |
| **Connection Pool** | DBUtils           |
| **Python Version**  | 3.7+              |

## 📦 Open Source Dependencies

- **Flask** – A lightweight Python web framework for backend APIs
- **PyMySQL** – A pure-Python MySQL client library
- **DBUtils** – Database connection pooling for improved performance
- **Vditor** – Easy-to-use Markdown editor, born to adapt to different application scenarios
- **Markdown** – A Python library for converting Markdown text into HTML
- **pymdown-extensions** – A collection of powerful extensions that enhance Python Markdown features
## 🚀 Quick Start

### Requirements

- Python 3.7 or higher
- MySQL 5.7 or higher

### Installation

1. Clone the repository

```bash
git clone https://github.com/ChanYiCYJ/Kimo.git
cd Kimo
```

2. Create a virtual environment

```bash
python -m venv venv
source venv/bin/activate  # Linux / Mac
venv\Scripts\activate    # Windows
```

3. Install dependencies

```bash
pip install -r requirements.txt
```

4. Create `config.json`:
```json
{
  "app": {
    "config": {
      "title": "Hello World",
      "introduction": "Hello World",
      "theme": "Default"
    }
  },
  "database": {
    "host": "your-db-host",
    "port": 3306,
    "user": "your-username",
    "password": "your-password",
    "name": "your-sql-name",
    "charset": "utf8mb4"
  }
}

```

5. 安装说明
配置并创建config.json后，使用
```bash
python manage.py
```
创建数据表和创建管理员账户，最后运行
```bash
python app.py
```
建议将项目克隆至电脑运行manage.py再将项目配置至云端
Application will start at: `http://localhost:80`

## 📄 License

This project is licensed under the **MIT License**.

## 👤 Author

**ChanYiCYJ**

---

Made with ❤️ by ChanYiCYJ