提供GraphQL API的Caluma服务
caluma的Python项目详细描述
协作表单编辑服务。在
什么是Caluma服务?在
Caluma服务是Caluma项目的核心部分,提供 GraphQL API。为了一个大的画面和学习什么卡鲁玛 给你看看caluma.io
入门
安装
注意:我们建议使用Caluma作为专用服务。然而,整合是可能的 卡鲁玛进入了django项目。你可以看看这个here。在
要求
- 码头工人
- docker撰写
在安装和配置这些之后,下载docker-compose.yml并运行以下命令:
docker-compose up -d
您现在可以访问GraphiQL,网址为 http://localhost:8000/graphql哪个 包括架构文档。API允许查询和改变表单 以及下面描述的工作流实体。在
Caluma是一个 意味着配置存储在环境变量中。 不同的环境变量类型在 django-environ。在
您可以在下面阅读有关运行和配置Caluma的更多信息 docs/configuration.md
调试
将环境变量ENV
设置为dev
,以启用调试功能。不要在生产中使用它,因为它会暴露机密信息!在
这将启用Django Debug Middleware。在
对于分析,可以使用./manage.py runprofileserver
。请参见docker-compose.override.yml
一个例子。在
许可证
在GPL-3.0-or-later license下发布的代码。在
有关许可证选择的更多信息,请阅读corresponding GitHub issue。在
进一步阅读
- Installation & Configuration-开始安装 生产环境中的Caluma
- Contributing-如果你想帮助我们,这里有 如何从你的第一个贡献开始。在
- Caluma Guide-如何与Caluma一起运行
- Workflow Concepts-如何使用caluma工作流
- Historical Records-撤消和审核跟踪 功能
- GraphQL-关于如何使用GraphQL的更多信息 接口
- Validation-验证用户输入
- Extending Caluma-扩展:数据可见性和 权限
- Caluma Events-对Caluma事件作出反应
- Using Caluma as django apps
- Interfaces
- Maintainer's Handbook-各种维护人员的操作指南 任务
- 项目
标签: