Skip to content

Commit c08e965

Browse files
committed
initial commit
0 parents  commit c08e965

File tree

156 files changed

+9062
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

156 files changed

+9062
-0
lines changed

.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* linguist-language=GO

.gitignore

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.buildpath
2+
.hgignore.swp
3+
.project
4+
.orig
5+
.swp
6+
.idea/
7+
.settings/
8+
.vscode/
9+
bin/
10+
**/.DS_Store
11+
gf
12+
main
13+
main.exe
14+
output/
15+
manifest/output/
16+
temp/
17+
temp.yaml
18+
bin
19+
20+
# env
21+
.env
22+
.env.*
23+
24+
# data
25+
data/

Dockerfile

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
FROM golang:1.20-alpine as builder
2+
ENV GOOS=linux
3+
ENV GOPROXY=https://mirrors.aliyun.com/goproxy/,direct
4+
ENV GOSUMDB=off
5+
ENV TZ=Asia/Shanghai
6+
7+
RUN apk add build-base
8+
9+
WORKDIR /build/xcoder/
10+
11+
COPY go.mod go.sum ./
12+
RUN go mod download
13+
14+
COPY . .
15+
16+
RUN GOOS=linux CGO_ENABLED=1 GOARCH=amd64 go build -ldflags="-s -w" -installsuffix cgo -o /app/main main.go
17+
18+
FROM alpine
19+
20+
RUN apk add --no-cache --virtual .build-deps \
21+
build-base \
22+
gcc \
23+
tzdata \
24+
wget \
25+
git \
26+
&& apk add --no-cache libstdc++ \
27+
&& apk del .build-deps
28+
29+
WORKDIR /app
30+
31+
COPY --from=builder /app/main /app/main
32+
33+
COPY manifest/config /app/config
34+
35+
EXPOSE 8081
36+
37+
RUN echo $'#!/bin/sh\n\
38+
exec /app/main\n\
39+
' > entrypoint.sh
40+
41+
RUN chmod +x /app/entrypoint.sh
42+
ENTRYPOINT ["/app/entrypoint.sh"]

LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Makefile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
ROOT_DIR = $(shell pwd)
2+
NAMESPACE = "default"
3+
DEPLOY_NAME = "template-single"
4+
DOCKER_NAME = "template-single"
5+
6+
include ./hack/hack.mk

README.MD

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# XCoder
2+
## 产品概述
3+
### 1. XCoder是什么?
4+
XCoder是一款基于大语言模型(LLM)的编码辅助工具,旨在提供智能化的代码推理和辅助功能。
5+
XCoder的开发灵感来源于类似产品 Copilot 的代码自动补全功能,无论是在功能还是性能方面都基于我们公司的现状进行了的优化和改良。
6+
XCoder目前已经过多个内测版本的迭代和用户反馈的持续优化。
7+
### 2. 核心功能和特点
8+
| 分类 | 支持的语言 |
9+
|----|--------------------------------|
10+
| 后端 | java、golang、python、c++、php ... |
11+
| 前端 | javascript、typescript、html ... |
12+
| 其他 | yaml、markdown、json ... |
13+
14+
| 功能 | 描述 |
15+
|-----------|----------------------------------------------------|
16+
| 单行、多行代码补全 | 根据用户当前上下文及 IDE 打开的其他文件获取 context ,生成接下来一行或者多行代码的内容 |
17+
| 智能chat | 提供对编码问题的智能回答和解决方案,帮助用户快速解决问题 |
18+
| 单元测试 | 根据所选函数及上下文,智能生成代码的单元测试用例 |
19+
| 代码文档及注释生成 | 根据所选代码,生成代码文档及代码注释 |
20+
| 代码优化 | 智能修改、重构、优化用户所选的代码 |
21+
| 代码解释 | 根据所选代码,生成对代码的功能解释 |
22+
| 代码编辑 | 根据用户给定的指令,进行修改或调整选中代码 |
23+
24+
### 3. 优势和价值
25+
1.提高编码效率:通过智能推理和代码补全功能,加速编码过程,减少重复劳动。
26+
2.提升代码质量:自动生成单元测试用例和提供代码修复建议,帮助用户编写更可靠和高质量的代码。
27+
3.加速学习曲线:对于初学者来说,XCoder提供了实时的代码推理和建议,帮助他们理解和学习编码。
28+
29+
## 快速开始
30+
31+
### XCoder 项目部署
32+
#### Docker 部署
33+
* 安装好 docker 及 docker-compose
34+
* 拉取项目代码
35+
* 模型配置:项目需要使用代码大模型以及通用 chat 大模型,需要自己本地部署好,或使用现有开源的大模型。不管使用那种方式,都需要将模型的连接串信息填写到 `manifest/config/` 目录的配置中,具体可以参考[项目参数配置](./docs/development.md#项目参数配置)
36+
* 进入项目 `manifest/deploy/docker-compose/` 目录,执行 `docker-compose up -d`
37+
38+
#### 本地构建
39+
* 安装 golang 1.18+
40+
* 拉取项目代码
41+
* 配置 mysql 及 mongodb 数据库信息,进入 `manifest/config/config.yaml` 配置自己的 mysql, mongodb 连接串信息
42+
* 模型配置:项目需要使用代码大模型以及通用 chat 大模型,需要自己本地部署好,或使用现有开源的大模型。不管使用那种方式,都需要将模型的连接串信息填写到 `manifest/config/` 目录的配置中,具体可以参考[项目参数配置](./docs/development.md#项目参数配置)
43+
* 通过环境变量指定项目配置文件,export CFG_BASE_DIR=manifest/config
44+
* 进入项目根目录,执行 `go mod tidy`
45+
* 进入项目根目录,执行 `go run main.go`
46+
47+
## 更多配置及部署
48+
更多项目的配置及部署信息,请参考[开发文档](./docs/development.md)

api/chat/v1/chat.go

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
package v1
2+
3+
import (
4+
"github.com/gogf/gf/v2/frame/g"
5+
"xcoder/internal/model/input/chatin"
6+
)
7+
8+
type ChatSseGenerateReq struct {
9+
g.Meta `path:"/sse" method:"post" tags:"智能 Chat" summary:"智能 Chat 生成接口"`
10+
chatin.ChatSseGenerateReq
11+
}
12+
13+
type ChatSseGenerateRes struct{}
14+
15+
type ChatResult struct {
16+
Error error `json:"error"`
17+
Data string `json:"data"`
18+
}

api/code/v1/code.go

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
package v1
2+
3+
import (
4+
"github.com/gogf/gf/v2/frame/g"
5+
"xcoder/internal/model/input/codein"
6+
)
7+
8+
type CodeGenerateReq struct {
9+
g.Meta `path:"/generate" method:"post" tags:"代码生成" summary:"代码生成接口"`
10+
codein.CodeGenerateRequest
11+
}
12+
13+
type CodeGenerateRes struct {
14+
Code string `json:"code"`
15+
}

api/comment/v1/comment.go

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
package v1
2+
3+
import (
4+
"github.com/gogf/gf/v2/frame/g"
5+
unittestin "xcoder/internal/model/input/unit_testin"
6+
)
7+
8+
type CommentSseGenerateReq struct {
9+
g.Meta `path:"/sse" method:"post" tags:"代码文档生成及注释" summary:"代码文档生成及注释生成接口"`
10+
unittestin.UnitTestSseGenerateReq
11+
}
12+
13+
type CommentSseGenerateRes struct{}

api/common/response.go

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
package common
2+
3+
type Response struct {
4+
Code int `json:"code"`
5+
Message string `json:"message"`
6+
Data interface{} `json:"data"`
7+
}

0 commit comments

Comments
 (0)