vas3k.club

欢迎来到vas3k.club代码库。我们正在建立自己的IT生活社区。我们已经开源了代码,以便每个成员都可以贡献或实现他们想要的功能。

vas3k.club是一个拥有私人和付费会员的平台,它围绕着vas3k.ru博客和卫星聊天室而兴起。它不是一个典型的IT社区,没有教程和框架评论,而更像是一个生活方式社区。我们试图建立一个和平、有用的生态系统,这是互联网很久以前就失去的。因此,我们会仔细挑选和过滤新成员,而不寻求疯狂的增长。

我们的价值观:诚实、公平分享、尊重其他成员、理性、友善和有用。我们对匿名、侮辱和毒性采取零容忍政策。但我们总是试图保持与现实的联系,所以我们也不容忍巫术猎杀和呼吁文化。

我们是一个无屁话的社区!

🛠 技术栈

👨‍💻 TL;DR: Django, Postgres, Redis, Vue.js, Webpack

我们尽量保持我们的技术栈简单和愚蠢。因为我们也不太聪明。

我们技术栈中最棘手的部分是如何将前端和后端开发为单一服务。我们不使用SPA,像许多人那样,而是通过将Vue.js组件直接插入到Django模板中来使页面的某些部分动态化。这可能看起来很奇怪,但它确实使一个人能够开发和维护整个网站变得非常容易。

你不需要真正理解webpack <-> django通信在后台如何工作,就可以开发新的组件。只需同时运行django runserver和npm run watch,就可以尽情编码了。

如果您知道如何做得更好,欢迎提出"最新技术"的UI或后端代码重构方案。我们对来自两个领域的最佳实践都持开放态度。

克隆代码仓库

$ git clone https://github.com/vas3k/vas3k.club.git
$ cd vas3k.club

这将在http://127.0.0.1:8000/上以开发模式启动应用程序,以及其他必要的服务:postgres数据库、带有工人的队列、redis和webpack。

第一次启动时,您可能需要一个测试账户才能正确登入。转到/godmode/dev_login/，它将为您创建一个管理员账户(并自动登录)。要创建新的测试用户,请访问/godmode/random_login/端点。

后端和前端的自动重载在每次代码更改时都会自动执行。如果一切都崩溃了,不起作用了(这种事情会发生),您随时可以使用docker-compose up --build从头开始重建整个世界。

有关如何测试电报机器人、不使用Docker运行项目以及其他有用说明的更多信息,请阅读docs/setup.md。

我们使用标准的Django测试框架。没有什么魔法,真的。您可以从PyCharm或使用Django CLI运行它们。

有关更多见解,请参见docs/test.md。

很抱歉,我们没有UI测试。也许将来会有

没有k8s,没有AWS,我们直接通过ssh发送docker,这很美妙!

整个生产配置在docker-compose.production.yml文件中描述。

然后,Github Actions必须完成所有脏活累活。它们会在每次合并到master分支时构建、测试和部署更改(只有官方维护人员可以这样做)。

探索整个.github文件夹,了解更多见解。

我们很乐意接受关于如何在不过度复杂化的情况下改善我们的部署的提议。

欢迎Fork。我们很小,我们的引擎不像Wordpress那么通用,但只要有足够的编程技能(和使用grep),您就可以在几周内启动自己的Club网站。

对每个人的三个巨大请求:

请表扬原作者。在您网站的页脚中写上"基于vas3k.club引擎运行"就足够了。
请与我们分享您实现的新功能,这样其他人也可以从中受益,而且您自己的代码库也不会与原始代码太过偏离(这样您就可以同步更新和安全修复)。使用我们的feature-flags。
请不要将我们的问题和其他官方渠道用作支持台。使用聊天。