## 快速开始
```shell
git clone https://github.com/staringos/mtbird-saas
```
### 1. 使用 Docker 启动
开启服务
```shell
yarn build-compose
yarn up-compose
```
### 2. 手动启动
需要 NodeJS 版本: >=18
1. 安装所有以来
```shell
yarn
```
2. 开启服务
```shell
yarn run start
```
## 配置
配置在项目目录下 `.env` 文件中，您也可以直接启动服务，使用星搭自带的安装界面进行安装
必须配置:
```shell
# mysql 数据库链接
DATABASE_URL="mysql://"
# Qiniu Cloud for CDN
QINIU_ACCESS_KEY=
QINIU_SECRET_KEY=
BUCKET=
BUCKET_REGISTRY=
# CDN URL
NEXT_PUBLIC_CDN_URL=
```
浏览器打开: http://localhost:3000/
Develop mtbird library mode see [this document](https://github.com/staringos/mtbird/tree/master/packages/mtbird-example)
## 常用资料
- 📃 页面绑定自定义域名，点击了解 [绑定域名](https://docs.staringos.com/?path=/docs/%E7%BC%96%E8%BE%91%E5%99%A8-%E7%BB%91%E5%AE%9A%E5%9F%9F%E5%90%8D--page)
- 🌟 快速了解星搭拓展开发，可以从这里开始 [快速开始](https://docs.staringos.com/?path=/docs/%E6%8B%93%E5%B1%95-%E4%BB%8B%E7%BB%8D--page)
- ⌚️ 快速了解业务系统接入星搭编辑器，可以从这里了解 [嵌入编辑器](https://docs.staringos.com/?path=/docs/%E7%BC%96%E8%BE%91%E5%99%A8-%E5%B5%8C%E5%85%A5%E7%BC%96%E8%BE%91%E5%99%A8--page)
- 🌺 快速了解业务系统接入星搭渲染器，可以从这里入门 [嵌入渲染系统](https://docs.staringos.com/?path=/docs/%E6%B8%B2%E6%9F%93%E5%99%A8-%E5%B5%8C%E5%85%A5%E6%B8%B2%E6%9F%93%E5%99%A8--page)
## 文档目录
- [拓展](https://docs.staringos.com/?path=/docs/%E6%8B%93%E5%B1%95-%E4%BB%8B%E7%BB%8D--page)
- [编辑器](https://docs.staringos.com/?path=/docs/%E7%BC%96%E8%BE%91%E5%99%A8-%E4%BB%8B%E7%BB%8D--page)
- [渲染器](https://docs.staringos.com/?path=/docs/%E6%B8%B2%E6%9F%93%E5%99%A8-%E4%BB%8B%E7%BB%8D--page)
- [DEMO](https://docs.staringos.com/?path=/docs/demos-%E7%BC%96%E8%BE%91%E5%99%A8--form-page)
- [参与开源贡献](https://docs.staringos.com/?path=/docs/demos-%E7%BC%96%E8%BE%91%E5%99%A8--form-page)
- [APIs](https://docs.staringos.com/?path=/docs/apis-%E6%95%B0%E6%8D%AE%E7%BB%93%E6%9E%84-%E7%BB%84%E4%BB%B6--page)
- [联系我们](https://docs.staringos.com/?path=/docs/%E6%9C%8D%E5%8A%A1-%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC--page)
## Contributing
欢迎大家提交 PRs 和 Issues.
[CONTRIBUTING](./CONTRIBUTING.md)
## 加入社群
