# OmcServer

**Repository Path**: pingtan_web/omc-server

## Basic Information

- **Project Name**: OmcServer
- **Description**: 项目基于openmodelica（omc），使用Flask搭建，具有简单交互功能。
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-06-24
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# omServer
本项目基于openmodelica（omc），使用Flask搭建，具有简单交互功能。
目前仅实现最基础功能。

## 运行使用（使用本地环境搭建）

#### 数据库安装
    提前安装好docker
    运行INSTALL-ENV.sh，完成数据库环境搭建

#### omc安装
    mysql、redis服务启动后，开启另一个终端
    运行INSTALL.sh，完成环境搭建

#### 创初始化数据库表
    使用Python执行manage.py脚本的init_db选项初始化表结构。
    不要以root用户运行
    python3 manage.py init_db
    初始化需要耗费一些时间，请耐心等待

#### 运行程序
    在开发环境中（以pychram举例），配置【Run/Debug configurations】，使用正确的Python环境运行manage.py即可。
    python3 manage.py

    在生产环境中（以CentOS举例），配置run.sh中uWSGI程序的正确路径，配置uWSGI的启动端口，然后运行脚本即可。
    需要注意的是示例脚本中uWSGI是以socket形式启动的，需要配置Web服务器作为代理（如Nginx）。或者将start函数中用于uWSGI启
    动的【-s ${host}:${port}】命令项改为【--http-socket ${host}:${port}】这样就能直接访问了。

#### 开始使用
    前端开发访问 /api/doc查看接口文档

## 运行使用（使用docker）
    TODO


## 相关文档
- [Flask中文文档](https://dormousehole.readthedocs.io/en/latest/)
- [uWSGI中文文档](https://uwsgi-docs-zh.readthedocs.io/zh_CN/latest/index.html)