ITADN
withstudiocms/studiocms
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

StudioCMS

Readme's Banner

NPM Version Formatted with Biome GitHub Actions Workflow Status (ci-testing.yml) Allure Test Report Crowdin pkg.pr.new Built with Astro

StudioCMS 是一个专为 Astro 生态系统构建的 SSR 无头 CMS。

要了解如何开始使用 StudioCMS,请参阅 StudioCMS 文档

本仓库中的包

Astro 集成

测试覆盖率
studiocmscodecov
@studiocms/devappscodecov

StudioCMS 插件

类别测试覆盖率
@studiocms/oauth身份验证codecov
@studiocms/html渲染器codecov
@studiocms/markdoc渲染器codecov
@studiocms/md渲染器codecov
@studiocms/mdx渲染器codecov
@studiocms/wysiwyg渲染器codecov
@studiocms/cloudinary-image-service图像服务codecov
@studiocms/blog前端codecov

工具和实用程序

测试覆盖率
@withstudiocms/auth-kitcodecov
@withstudiocms/buildkitcodecov
@withstudiocms/component-registrycodecov
@withstudiocms/config-utilscodecov
@withstudiocms/effectcodecov
@withstudiocms/internal_helperscodecov
@withstudiocms/kyselycodecov
@withstudiocms/template-langcodecov

开始使用我们的开发游乐场

StudioCMS Playground 旨在用于在 monorepo 中开发 StudioCMS 时,不应直接用于测试或托管 StudioCMS。如果您的目标是测试我们的 CMS,请使用我们来自 npm 的最新版本。

获取一个可运行的 playground 的步骤应如下:

  • 克隆 GitHub 仓库
  • 运行 pnpm i --frozen-lockfile
  • 将 Node playground 的 StudioCMS 配置 中的 dbStartPage 更改为 true
    • 如果使用非 libsql 数据库,请确保 StudioCMS 配置中的 db.dialect 选项与您期望的数据库类型匹配!
  • 确保已配置 .env 变量(请参阅 .env.demo 以查看可用环境变量的示例)。
  • 按以下顺序运行:
    • pnpm build:studiocms - 构建 StudioCMS 包(对于获取 StudioCMS 集成的当前表结构是必需的)。
    • pnpm playground:migrate --latest - 更新您的数据库架构以与最新的迁移版本保持一致。
    • pnpm dev - 启动连接到关联数据库的 Dev 服务器(同时构建所有仓库包)。

一旦该过程成功完成,您就可以导航到 http://localhost:4321/start 并按照说明初始化您的数据库。

完成后,您将被重定向并被要求关闭并将配置选项 dbStartPage 更改为 false。这将启用 CMS 的全部功能。现在您可以使用 pnpm dev 重新启动 dev 服务器,以继续在我们的开发 playground 中工作。

这将为您提供我们日常使用的开发环境。

要再次启动 playground,请使用命令 pnpm dev

我们的工具集

有关我们主要工具的最新列表,请查看我们的 .prototools 文件

有关 Proto 的更多信息,请查看 Proto 的网站

贡献

我们欢迎来自社区的贡献!无论是 bug 报告、功能请求还是代码贡献,我们都感谢您在改进此项目方面提供的帮助。

Bug 报告和功能请求

如果您遇到任何 bug 或有新功能想法,请在我们的 GitHub 仓库 上提交 issue。创建新 issue 时,请尽可能提供详细信息,包括重现问题的步骤(针对 bug)以及对所提议功能的清晰描述。

代码贡献

我们欢迎来自社区的贡献!无论是 bug 报告、功能请求还是代码贡献,我们都感谢您在改进此项目方面提供的帮助。要开始贡献,请阅读我们的 贡献指南

请注意,通过为此项目做出贡献,您同意我们的 行为准则

与我们聊天

我们在 StudioCMS Discord 服务器 上有一个活跃的开发者社区。欢迎加入并与其他贡献者交流、提问,或讨论与此项目或其他 StudioCMS 项目相关的想法。

赞助商

Turso logo Skip2 logo

许可

MIT 许可.