82

0

BoostNote

Boost Note 是一种文档驱动的项目管理工具,可最大限度地提高远程 DevOps 团队的速度。

Boost Note 是一种文档驱动的项目管理工具,可最大限度地提高远程 DevOps 团队的速度。

https://boostnote.io/

uiimage

👷核心团队(维护者)

📦下载应用程序

🖥桌面

📱移动的

💥有什么烦恼吗?

如果您不知道如何使用该应用程序,请在我们的问答讨论页面上创建讨论。

如果您发现错误,请向我们的 GitHub 问题跟踪器创建问题。

如果是紧急或私人的,请加入我们的 Slack 频道并直接发送消息至@rokt33r。

🤲想贡献?

如果您对我们的项目感兴趣,您可以通过多种不同的方式参与。

  • 分享你的想法
  • 帮助社区
  • 解决现有问题

阅读我们的贡献指南,了解我们的开发过程,如何提出错误修复和改进。

分享你的想法

为了改进应用程序,我们需要您的想法!它可能是一项新功能,也可能是对现有功能的改进。如果您有任何问题,请在功能请求类别中创建讨论。

帮助社区

有很多方法可以帮助我们的社区。您可以通过撰写文章分享您如何使用我们的应用程序。您可以在一般讨论页面、外部开发者社区(Dev.to 或 Reddit)和您的博客(如果有)中编写它。

此外,您可以通过在此处回答其他用户的问题来帮助他们。

解决现有问题

我们为一些外部贡献者可以尝试解决的问题留下了“需要帮助”的标签。其中一些可能有少量赏金,因此您可以在黑客入侵后从中获得一杯咖啡。如果您发现任何有趣的问题,但它们的规格不明确,或者您不知道如何解决它们,请对这些问题发表评论。然后,我们会给你更多的指示。

发展

目前,我们仅提供前端源代码,因此您无法自行托管我们的后端服务器。但是您可以通过模拟后端模式参与开发。虽然它还没有涵盖所有 API,但您可以访问基本的文件夹和文档管理。

如何运行应用程序

创建 .env 文件。

NODE_ENV=development
MOCK_BACKEND=true

运行 webpack 处理器。您必须在单独的终端中运行它们。

npm run dev:cloud
# You can skip next two scripts if you don't need to run electron app.
npm run dev:electron
npm run dev:webpack

如何扩展模拟后端

启用该模式后,所有 API 调用都将传递给 src/cloud/api/mock/mockHandler.ts.

源代码与路由器接口非常相似。您只需要 method,pathname和一个处理函数。因此,当您 Not Found在调用时遇到错误时 GET /api/something,您可以简单地添加如下所示的模拟路由。

{
  method: 'get',
  pathname: 'api/something',
  handler: ({ search }): GetSomethingResponse => {
    return {
      ...something
    }
  },
}

脚本

  • 开发脚本
    • npm run dev:cloud: 为云空间运行 webpack
    • npm run dev:webpack:为桌面应用程序主窗口渲染器运行 webpack
    • npm run dev:electron:为桌面应用程序主处理器运行 webpack
    • npm run dev:mobile: 为移动应用运行 webpack
    • npm run lint: 检查 lint 错误
    • npm run format: 尝试自动修复 lint 错误
    • npm test: 运行测试脚本
    • npm run tsc: 检查类型错误
  • 构建脚本
    • npm run build:electron-production: 为桌面应用构建资产
    • npm run build:cloud-production:为云空间构建资产
    • npm run build:mobile-production: 为移动应用构建资产
    • npm start:使用预建资产运行桌面应用程序
    • npm run meta: 为桌面应用程序构建准备元数据(为电子构建模块生成 package.json)
    • npm run prepack:无需签名即可创建桌面应用安装程序
    • npm run release:为生产创建桌面应用安装程序并将其上传到 GitHub

🔗链接

⚖️执照

GPL-3.0 © 2016 - 2022 BoostIO