Geeknote 开源

很高兴的宣布,Geeknote 已经开源,仓库位于 https://github.com/chloerei/geeknote

为什么开源?

开源的想法由来已久,其中一个原因是开源很酷。我管理的另一个社区 Ruby China 是开源的,Geeknote 借鉴的网站之一 dev.to 是开源的,所以我也想把 Geeknote 开源。

另一个原因是我想给 Ruby on Rails 社区提供一个适合新手友好的开源项目。Rails 的开源项目不少,知名的例如 DiscourseGitLabChatwoot 等。但这些项目由于历史积累和业务复杂度,其实不适合新手阅读。

什么是新手友好?

Geeknote 是新手友好的,有两个原因。

首先,Geeknote 的业务不复杂。作为一个博客社区,核心模型就是用户-文章-评论,理解起来比较简单。但因为 Geeknote 已经运营了四年,有一些技术债,所以也不是周末项目那么简单,对于现实项目也有参考价值。

其次,Geeknote 尽量使用 Rails 默认栈的技术。例如,使用 Hotwire 而不是前后端分离,使用 Minitest 而不是 Rspec,使用 Rails auth generator 而不是 devise。我优先选择无聊的技术,这样更容易维护,有更多时间花在产品上。

如何使用?

要启动开发环境,只需要用 vscode 打开项目目录,会自动提示启动 devcontainer 环境。

要部署到服务器,可以参考项目 Wiki。目前文档比较简陋,后面我会根据需要更新。

项目基于 MIT License 开源,你可以用于搭建自己的社区,或者 Fork 添加自己的功能。如果发现 Bug,可以打开 Issue 或者 Pull Request;如果想要贡献新功能,建议开发前先到 Discussion 发帖,Geeknote 接受新功能倾向于保守。

有其他疑问欢迎评论留言。Just for fun!

1
0
0
所有评论 0
@Rei
Ruby 程序员,Ruby China 管理员,GeekNote 创建者。