README

Coldreader是一个休闲的个人数据库系统。

可以将其视为思维导图和私人维基之间的中间产品。我使用它来代替Evernote，作为个人信息管理工具。初始时，它可能看起来有些简单，但一旦你开始用你自己的自定义功能来构建它，你会发现几乎没有其他工具能与之媲美。

Coldreader不会对你想要跟踪的信息类型做任何假设。在Coldreader中，本质上有两种类型的东西：主题和方面。

一个主题可以包含任意数量的方面。方面就像一个单一的内容单元。这可能是一段文本、一张图片、API结果等等。本质上，一个基本的方面只是将信息作为文本存储在数据库中。但你可以用一点代码扩展简单的方面，让它们以你喜欢的任何方式运行。通过修改样板代码并添加你自己的逻辑，你可以检索API结果、执行计算，等等。有关更多信息，请参阅下文“开发自定义方面”。

Coldreader主要针对那些熟悉使用PHP和JavaScript进行基本Web开发的人。它使用Laravel 5.6、Bootstrap 3和Vue.js构建。

这是开源版本。它配置为支持单个用户，并包含一些工具，便于您根据自身需求自定义系统。

用例

• 项目管理系统
• 个人CRM系统
• 构建自定义仪表板以跟踪感兴趣的主题
• 管理您的媒体收藏
• 在研究新事物时跟踪您的笔记和参考资料
• 创建一个您已解决的问题的知识库
• 保存您最喜欢的食谱库
• API测试床 - 通过实现API和使用现有数据快速添加新功能
• 以您喜欢的任何方式组织数据

安装

Coldreader基于Laravel 5.6，需要一台能够提供Laravel项目服务的服务器，或者安装了Docker和Docker Compose的任何机器。

有关服务器要求的详细信息，请参阅Laravel文档。

Homestead vagrant虚拟机与Coldreader配合良好，您可以在本地环境中尝试它，没有任何风险。有关使用Laravel Homestead的更多信息，请参阅他们的优秀文档。

通过docker-compose

在本地机器上设置Coldreader进行开发的最简单方法之一是使用docker-compose文件。当然，这需要在您希望运行软件的机器上设置Docker。

• 将仓库克隆到方便的位置。
• cd进入克隆仓库的目录。
• 编辑.env文件以符合您的偏好。
• 运行docker-compose up。这将构建应用程序堆栈。
• 第一次运行docker-compose up时，构建堆栈可能需要相当长的时间。这是正常的。后续的构建将更快。
• 应用程序将在： http://127.0.0.1 上可用。您可以在： http://127.0.0.1:8080 访问Adminer以操作数据库。
• 需要运行 artisan 命令？需要用 webpack 重新构建资产？您可以在 Docker 容器中使用常规方法完成这些操作。要获取 bash shell
  • 在 Windows 系统上，只需运行 larabash.bat
  • 在 Mac 和类似 Unix 的系统上，只需运行 docker-compose exec laravel bash

安装额外的插件

Coldreader 的一个优点是创建新的 Aspect Types 和 Search Providers 来适应不同类型的数据以及不同的显示方式非常容易。有一些 Aspect Types 可以试用。

要安装 Coldreader 插件包，请在应用程序容器中使用 composer

$ composer require <vendor>/<package_name>
$ composer update

某些插件包可能需要额外的配置。请查阅任何单个插件的具体配置细节。

目前可用的插件

• 即将推出！

使用 Coldreader 进行开发

有关如何开始使用 Coldreader 进行开发的说明和示例，请参阅维基百科。

变更日志

请参阅 CHANGELOG 了解最近有哪些变更。

测试

在应用程序容器的 bash 中

$ cd application
$ composer test

贡献

请参阅 CONTRIBUTING 和 CONDUCT 了解详细信息。

安全

如果您发现任何安全相关的问题，请通过电子邮件 ian@ianmonroe.com 反馈，而不是使用问题跟踪器。

鸣谢

• Ian Monroe
• 所有贡献者

许可证

GPL V3。请参阅 许可证文件 了解更多信息。