# LobsterBoot开发文档

**Repository Path**: lobsterboot/lobsterboot_docs

## Basic Information

- **Project Name**: LobsterBoot开发文档
- **Description**: LobsterBoot开发文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-22
- **Last Updated**: 2025-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![](images/logo1.png)<br>

# LobsterBoot

## 介绍

LobsterBoot是一种新的应用系统开发方式，在线开发前端、后端代码，无需在本地搭建开发环境、安装开发IDE工具，通过浏览器就可以进行开发、调试。主要开发语言采用Typescript，整合了Gitee平台进行代码自动托管，服务部署在Docker。 LobsterBoot是一个开源底层开发框架，类似SpringBoot框架。

以下系统采用LobsterBoot框架进行扩展开发：  
1. LobsterWebIDE(在线代码编辑器)  
2. LobsterAdmin(后台管理系统)  



## 软件架构

![](images/微信截图_20231010112915.png)<br>


## 快速使用

* 方式一，拉取LobsterBoot Docker镜像进行部署使用
  
1.  在Docker中部署LobsterBoot

```shell
$ docker pull registry.cn-hangzhou.aliyuncs.com/kakake/lobsterboot:latest
$ docker run -d -p 7777:80 -p 7222:7222 --restart=always --name lobsterboot registry.cn-hangzhou.aliyuncs.com/kakake/lobsterboot:latest
```
2.  打开`http://localhost:7777/bootconfig.html`，进行应用配置，默认登录密码`Lobster@123456`
3.  在Gitee网站上进行配置后，编写应用代码

* 方式二，在netcore项目中引用lobsterboot类库


1. 引用Lobster.Boot.dll类库
```xml
<PackageReference Include="Lobster.Boot" Version="1.0.0" />
```

1. 创建lobsterboot.json文件
```json
{
    "LoginPassWord": "Noz2wU8j02qvDMAqqTE+uA==",
    "Gitee": {
        "ClientId": "10a98ef50311779283b652142c19db3b6a3cba8dd7b2ab26e12cb9cb6a046f58",
        "ClientSecret": "7a2690421cb1e6b8196680e1f6b6bc7c28922d754c668c8a5f1678747c5b6423",
        "RedirectUri": "https://localhost:7184/bootconfig.html",
        "AccessToken": "9709bc26281666f79b479aadab2e6daa",
        "RefreshToken": "61d941374ad6693a75e6ae39e7cdc4f83e0a326c3e2304768e120b7025f19dc2"
    },
    "AppList": [
        {
            "AppId": 3052,
            "AppKey": "APP20210329185258876",
            "AppName": "模板应用",
            "AppImage": "https://lobsteross.mcloudsoft.cn/20221108/50435422-7be8-4eaa-a272-315901701456.png",
            "AppSecret": "7fdbc0ffc06546277acb945798",
            "gitee_repo": {
                "owner": "kakake",
                "repo": "lobsterboot-3052-books",
                "refs": "master"
            },
            "menus": [
                {
                    "name": "书籍管理(在线Web)",
                    "href": "/webapp/3052/bookmanage.html",
                    "children": null
                }
            ],
            "databases": [
                {
                    "DBName": "LobsterPlatform",
                    "UserName": "sa",
                    "Pass": "*****",
                    "ServerName": "42.192.250.43",
                    "DBPort": "1433",
                    "DbType": "sqlserver",
                    "DefaultFlag": true
                }
            ],
            "maskingrules": [
                {
                    "Name": "名称脱敏",
                    "Fields": "BookName",
                    "StartNum": 1,
                    "EndNum": 1,
                    "ReplaceChar": "*",
                    "ExcludeFunname": ""
                }
            ],
            "lastpulldatetime": "2023-10-14 23:53:41",
            "lastpublishdatetime": "2023-10-14 23:53:42",
            "environment_pro": false
        }
    ],
    "CustomFactory": [
        {
            "dll": "Lobster.Boot",
            "type": "Lobster.Boot.ClearScript.IClearScriptHandler"
        }
    ]
}
```

1. 修改Program.cs
```csharp
 builder.Services.AddLobsterBoot(builder.Configuration, logger);

 app.UseLobsterBoot(app.Environment, app.Configuration);
```

4. 修改appsettings.Development.json
```json
{
  "Logging": {
    "LogLevel": {
      "Default": "Trace",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "ConnectionStrings": {
    "DbType": "sqlserver", //数据库类别：sqlserver、uxdb、npgsql、mysql、sqllite等
    "DefaultConnection": "server=42.192.250.43;database=lobsterplatform;uid=sa;pwd=;",
    "RedisConnection": "42.192.250.43:6379,password=,defaultdatabase=0"
  },
  "RabbitMQ": {
    "Host": "42.192.250.43",
    "Password": "",
    "Port": 5672,
    "UserName": "admin",
    "VirtualHost": "/admin"
  },
  "App": {
    "ApiGateway": "https://apple.mcloudsoft.cn"
  }
}
```


## 功能说明

1. 应用配置

配置地址：`http://localhost:7777/bootconfig.html`

![](images/微信截图_20231011201503.png)<br>

2.  在LobsterWebIDE中编写代码

![](images/微信截图_20231027204427.png)<br>

3.  接口调试

第一步：在浏览器输入chrome://inspect/#devices，配置地址localhost:7222

第二步：将出现Remote Target#LOCALHOST，点击inspect打开DevTools界面

第三步：打开接口https://localhost:7777/lobsterapi/?fun=tsbook.getdata2&view=layui&appid=3052&debug=true

第四步：DevTools界面将自动进入断点，进行调试api代码

![](images/微信截图_20231010100802.png)<br>

4. 应用预览
    
预览地址：http://localhost:7777/apppreview.html

![](images/微信截图_20231015212115.png)<br>


## -----------------


## LobsterSDK文档

[查看LobsterSDK文档](lobstersdk.md)


## LobsterWebIDE介绍

[查看LobsterWebID文档](LobsterWebIDE.md)


## LobsterAdmin介绍

[查看LobsterAdmin文档](LobsterAdmin.md)

## -----------------

## 如何创建Lobster应用

[查看文档](CreateLobsterApp.md)

## 提供给第三方调用LobsterAPI接口

[查看文档](CallLobsterAPI.md)

## 实体ORM的使用

[查看文档](LobsterORM.md)

## LayUI自定义控件使用

[查看文档](LobsterLayUIControls.md)

## JS模块和CS模块的使用

[查看文档](LobsterModule.md)

## 常见问题

[查看文档](question.md)