devstar/README.md

# DevStar

The Last Mile of Al for R&D

## Purpose

DevStar Studio是为AI时代打造的新一代一站式智能研发平台，面向人类开发者和AI开发者的融合团队，专注于产品质量和团队效能，为研发部门赋能提效。

As [Gitea](https://github.com/go-gitea/gitea) is written in Go, it works across **all** the platforms and
architectures that are supported by Go, including Linux, macOS, and
Windows on x86, amd64, ARM and PowerPC architectures.
This project has been
[forked](https://blog.gitea.com/welcome-to-gitea/) from
[Gogs](https://gogs.io) since November of 2016, but a lot has changed.

* For online demonstrations, you can visit [DevStar.cn](https://DevStar.cn).
* You can find comprehensive documentation on our official [documentation website](https://mengning.com.cn/src/devstar/).
* If you have any suggestions or would like to contribute to it, you can visit [devstar/docs](/docs) and the [documentation repository](https://devstar.cn/devstar/docs)

## Building

Build devstar-studio:latest From the root of the source tree, run::
```
make devstar 
```
or Build a binary file named `gitea` From the root of the source tree, run:

    TAGS="bindata" make build

or if SQLite support is required:

    TAGS="bindata timetzdata sqlite sqlite_unlock_notify" make build

The `build` target is split into two sub-targets:

- `make backend` which requires [Go Stable](https://go.dev/dl/), the required version is defined in [go.mod](/go.mod).
- `make frontend` which requires [Node.js LTS](https://nodejs.org/en/download/) or greater.

Internet connectivity is required to download the go and npm modules. When building from the official source tarballs which include pre-built frontend files, the `frontend` target will not be triggered, making it possible to build without Node.js.

More info: https://docs.gitea.com/installation/install-from-source

## Using

Build and Start from Container Image:

```
make devstar # Build devstar-studio:latest
public/assets/install.sh start --image=devstar-studio:latest

# 查看日志
public/assets/install.sh logs
# 停止并删除devstar-studio容器
public/assets/install.sh clean
# 删除所有容器
sudo docker stop $(docker ps -aq) && sudo docker rm -f $(docker ps -aq)
```

or, After building, a binary file named `gitea` will be generated in the root of the source tree by default. To run it, use:

    ./gitea web

> [!NOTE]
> devcontainer相关功能不能在localhost域名下正常工作，调试环境请在custom/conf/app.ini中修改为IP地址

## Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

如果您是在Windows环境下，请在cmd命令行下先运行如下命令：

```
wsl --install -d Ubuntu-20.04 && wsl --setdefault Ubuntu-20.04
```

在Ubuntu-20.04下完成安装：

```bash
# download and install go
wget -c https://go.dev/dl/go1.24.6.linux-amd64.tar.gz 
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.24.6.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin
go version

# download and install Node.js
wget -c https://nodejs.org/dist/v22.11.0/node-v22.11.0-linux-x64.tar.xz
sudo tar -xf node-v22.11.0-linux-x64.tar.xz -C /usr/local/
echo 'export PATH=/usr/local/node-v22.11.0-linux-x64/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
node -v # should print `v22.11.0`
npm -v # should print `10.9.0`
```

在DevStar Git仓库创建分支
```
git clone https://devstar.cn/devstar/devstar.git
git checkout -b YOUR_BRANCH
code devstar

# in VS Code Terminal
TAGS="timetzdata sqlite sqlite_unlock_notify" make watch # for debuging
make test # testing
TAGS="bindata timetzdata sqlite sqlite_unlock_notify" make build # 生成可执行文件
./gitea

# 镜像方式安装验证
make devstar # Build devstar-studio:latest
public/assets/install.sh start --image=devstar-studio:latest

# 提交代码
git add FILES
git commit -m "commit log"
git push
```

在DevStar Git仓库发起Pull Request，合并代码后会自动触发CI流水线完成容器镜像的构建并上传到 mengning997/devstar-studio:latest 和 devstar.cn/devstar/devstar-studio:latest 

```
public/assets/install.sh start
```

> [!NOTE]
>
> 1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
> 2. If you have found a vulnerability in the project, please write privately to **contact@mengning.com.cn**. Thanks!

## Official and Third-Party Projects

* [webTerminal](https://devstar.cn/devstar/webTerminal) for DevStar devcontainer
* [devstar-vscode](https://devstar.cn/devstar/devstar-vscode) 
* [action runner](https://devstar.cn/devstar/act_runner) for DevStar Action
* [go-sdk](https://gitea.com/gitea/go-sdk)
* a CLI tool called [tea](https://gitea.com/gitea/tea)

We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea), where you can discover more third-party projects, including SDKs, plugins, themes, and more.

## License

This project is licensed under the AGPL-3.0 License.

> *   **Community Edition (Free):**
>     *   Includes the standalone version of DevStar Studio.
>     *   Free to use and deploy.
>     *   Technical support is not included.
> *   **Enterprise Edition (Paid):**
>     *   Requires a commercial license.
>     *   Unlocks Kubernetes-related features and other advanced functionalities.
>     *   Includes technical support.

See the [LICENSE](https://github.com/mengning/DevStar/blob/main/LICENSE) file for the full license text.