README.md

Use for free | Website ｜ Docs ｜ Demo ｜ Github

MtBird SaaS 中文文档

MtBird-SaaS is a low-code platform for HTML Page、Website. We help to build page without code or less code. It also support Wechat Mini-Program. This is fully repository, the main frontend editor is isolated, see this mtbird editor

Online Product

Getting Start

git clone https://github.com/staringos/mtbird-saas

1. Start in docker

Start server

yarn build-compose
yarn up-compose

2. Start Manually

Require NodeJS version: >=18

1. Install dependencies

yarn

2. Start server

yarn run start

Configuration

Config file from .env

Requirement:

# mysql 数据库链接
DATABASE_URL="mysql://"

# Qiniu Cloud for CDN
QINIU_ACCESS_KEY=
QINIU_SECRET_KEY=
BUCKET=
BUCKET_REGISTRY=

# CDN URL
NEXT_PUBLIC_CDN_URL=

Open: http://localhost:3000/

Develop mtbird library mode see this document

More Usage

• Fontend Editor component mtbird

• 📃 Bind your domain name Bind Domain

• 🌟 Develop mtbird extension Getting Start

• ⌚️ Emb Editor in your project or SaaS service Embed Editor

• 🌺 Know how to embed MtBird Renderer Embed Renderer

Docs

• Extension
• Editor
• Renderer
• DEMO
• Contributing
• APIs
• Contact Us

Contributing

PRs & Issues are all welcome, feel free to ask question or submit your code.

CONTRIBUTING