Skip to content

kaiyuanshe/osschat

Repository files navigation

OSSChat

Powered by Wechaty Node.js CI ES Modules

OSS Chat

Apache OSS.Chat Project.

Deploy

What is OSSChat

OSSChat is for bridging IM apps (e.g., WeChat) and Apache community tools (e.g., mailing list, and jira).

OSSChat will serve users as a cloud service.

HOT! OSS.Chat 加入 2022 年腾讯“开源摘星计划”

开源摘星计划

开源摘星计划(WeOpen Star) 是由腾源会 2022 年推出的全新项目,旨在为开源人提供成长激励,为开源项目提供成长支持,助力开发者更好地了解开源,更快地跨越鸿沟,参与到开源的具体贡献与实践中。

不管你是开源萌新,还是希望更深度参与开源贡献的老兵,跟随“开源摘星计划”开启你的开源之旅,从一篇学习笔记、到一段代码的提交,不断挖掘自己的潜能,最终成长为开源社区的“闪亮之星”。

详情:OSS.Chat X 开源摘星计划

Using OSSChat as a service

TBD

Run OSSChat locally

To run OSSChat, Node.js is required.

Install Node.js first if you are not.

npm install
npm run heroku:local

Then visit http://localhost:5000

Output Messages

After started the bot you should see the following log messages:

16:57:45 INFO Wechaty <wechaty-puppet-puppeteer>(heroku-wechaty) start() v0.29.7 is starting...
16:57:47 INFO startWeb startWeb() listening to http://localhost:8788

After scan the qrcode, you can find the following result here

17:12:57 INFO chatops chatops(Der! I just got online!
OSSChat v0.0.24)
17:12:57 INFO startBot onLogin(Contact<李佳芮>) 李佳芮 Heroku Wechaty Getting Started v0.29.7 logined

Advance

  1. Using an advance puppet to get a more stable version. Learn more about it from the Wechaty Puppet Directory

  2. Using Chatopera Cloud Services to enable more dialogue skills and user engagements. (#TODO Blog, #156)

DevOps & CI/CD

Heroku

We are current DevOps the master branch from the repo to Heroku under the protection of Travis CI.

You can visit the online system at https://oss.chat

Docker

Build docker image with scripts/build.sh, after that service can be hosted with docker-compose.

cp sample.env .env # Modify .env file with your settings
docker-compose up -d

Note, the current docker image for osschat is not pushed into DockerHub yet.

How to use

use osschat is so easy, just need 4 steps, please refer How to use

Meeting Notes

Apache Incubator Proposal

Mentors

Committers

Pilots

To be added...

contributor contributor contributor contributor contributor contributor contributor contributor

History

Master v0.11

v0.10 (Nov 2, 2021)

This branch works with Wechaty v0.68, for compatible with those modules (like PadLocal) does not support Wechaty v1.0 (yet)

v0.9 (May 30, 2021)

  1. Upgrade RxJS to v7
  2. Upgrade Wechaty to v0.60

Thanks

  • OSS mentored by: Apache Software Fundation
  • Project Lead by: 开源社
  • Heroku Dyno sponsored by: JuziBot
  • Wechaty Puppet Padplus sponsored by: JuziBot
  • Heroku Getting Started Template from Wechaty

Links

Copyright & License

  • Code & Docs © 2019-now 开源社
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons