# mkfree-deploy

**Repository Path**: skymysky/mkfree-deploy

## Basic Information

- **Project Name**: mkfree-deploy
- **Description**: Mkfree Deploy 自动化部署系统，为什么重复造轮子，不是有jenkins吗？jenkins功能更加强大了，为什么不使用？开发这玩意纯粹是玩玩，顺便学习一下前端。 mkfree-deploy 一个web部署系统工具，配置简单、功能完善、界面流畅、开箱即用！支持git版本管理，支持各种web代码发布，PHP，Python，JAVA等代码的发布、回滚，可以通过web来一键完成。
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/381895649/mkfree-deploy
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 47
- **Created**: 2020-04-30
- **Last Updated**: 2021-11-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#  Mkfree Deploy 自动化运维系统

### 简述
- Mkfree Deploy 自动化部署系统，为什么重复造轮子，不是有Jenkins吗？Jenkins功能更加强大了，为什么不使用？开发这玩意纯粹是玩玩，顺便学习一下前端。
- Mkfree Deploy 一个web部署系统工具，配置简单、功能完善、界面流畅、开箱即用！支持Git版本管理，支持各种web代码发布，PHP，Python，Java等代码的发布、回滚，可以通过web来一键完成。
- 其实还有很多功能没有完善。
- 之前的版本是使用Java开发，现在用Typescript重写整个项目。
- 轻量级部署工具
- 有任何疑问添加QQ：381895649

### 技术栈（Typescript贯穿前后端）
- 语言：Typescript、Less、Html、Shell、Sql、Nodejs
- 前端： React、Dva、Umi、Ant-Design、Webpack
- 后端：Nodejs、Nestjs、Typeorm
- 数据库：Sqlite3

### 原理分析
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-deploy.jpeg)

### 用它可以做些神马？
- 用户管理
- 项目的用户权限管理
- 项目管理
- 版本回滚
- 支持多项目部署


## 快速开始

### 环境
- 操作系统 Centos 或者 Ubuntu（版本越新越好）

### 安装（Centos为例演示一下安装过程）

#### 1、安装Git
````bash
yum install git
````
确认Git已经安装成功
````bash
git version
````
输出：git version 1.8.3.1

#### 2、安装 Nodejs LTS版本
````bash
# 版本LTS越新越好哦
wget https://nodejs.org/dist/v12.18.1/node-v12.18.1-linux-x64.tar.xz
xz -d node-v12.18.1-linux-x64.tar.xz
tar -xvf node-v12.18.1-linux-x64.tar.xz
````
确认 Nodejs 已经安装成功，环境变量配置一下。
````bash
node -v
````
输出：v12.18.1
#### 3、安装cnpm
参考资料：https://developer.aliyun.com/mirror/npm/package/cnpm
````bash
npm install cnpm -g
````

#### 4、安装Nestjs
参考资料：https://docs.nestjs.com
````bash
cnpm install -g @nestjs/cli
````
Nestjs安装后，把nest添加到环境变量中。

#### 4、启动项目
4.1、git clone 项目
````bash
mkdir devops
cd devops
git clone https://gitee.com/oyhk/mkfree-deploy.git
cd mkfree-deploy/backend
````
4.2、切换到最新release/1.1.0版本分支
````bash
git checkout release/1.1.0
````
4.3、安装依赖
````bash
cnpm install
````
4.4、构建项目
````bash
npm run build
````
4.5、运行
````bash
node dist/main.js
````
启动后，系统会自动生成数据文件，node服务运行在5000端口上。

------
### 如何使用

#### 1、访问链接： http://localhost:5000 ，自动跳转到系统安装页面
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-install.png)
#### 2、输入相关信息安装系统
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-install3.png)
#### 3、安装成功
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-install-success.png)
#### 4、登录
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-login.png)
#### 5、系统主界面
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-welcome.png)

### 如何部署（例如部署一个Java项目）
- 环境管理
    - 添加环境
- 服务器管理
    - 添加服务器
- 项目
    - 添加项目
    - 部署项目

#### 环境管理（通常来说项目都有多个环境，比如DEV、UAT、PRE、PROD）
##### 管理页面
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-env-manager.png)
##### 创建页面
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-env-new.png)
##### 创建成功
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-env-new-success.png)

#### 服务器管理（通常来说就是本地服务器或者云服务器）
#### 管理页面
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-server-manager.png)
##### 创建页面
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-server-new.png)
##### 创建成功
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-server-new-success.png)

#### 项目管理（通常来说就是需要部署到服务器上的项目）
#### 管理页面
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-project-manager.png)
##### 创建页面
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-project-new1.png)
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-project-new2.png)
##### 创建成功
![image](https://gitee.com/oyhk/mkfree-deploy/raw/master/doc/images/mk-project-new-success.png)