getting started
1.0.0
Wechaty est un SDK (kit de développement logiciel) RPA (Robotic Process Automation) conversationnel pour les créateurs de chatbots. Il est bien conçu avec une API facile à utiliser. Il prend en charge tous les systèmes d'exploitation, notamment Linux, OSX, Win32, Docker et de nombreux services de messagerie instantanée (services de messagerie instantanée), notamment WeChat, WeCom, Whatsapp, Lark, Gitter, etc.
En tant que développeur, vous pouvez utiliser Wechaty pour créer facilement votre bot, gérer efficacement l'envoi et la réception de messages, la création de salles et l'envoi d'invitations, contacter des amis et ajouter délicieusement une intelligence artificielle entre les utilisateurs et votre bot.
Si vous êtes un débutant total sur Wechaty, ce projet est le meilleur point de départ pour vous. Vous pouvez l'exécuter sur un Cloud IDE en quelques étapes ou sur une configuration locale sur votre machine comme décrit dans les sections ci-dessous.
Si vous rencontrez des difficultés ou avez des questions, vous pouvez demander de l'aide dans notre communauté Discord à l'adresse https://discord.gg/7q8NBZbQzt.
Remarque : la version active actuelle de Wechaty est la v1.x qui n'est pas compatible avec la plupart des modules v0.x.
[email protected] - Pour utiliser Wechaty v0.x, veuillez visiter la branche Wechaty Getting Started v0.x.dong lorsqu'il reçoit un message ding .
Ci-dessus, vous trouverez un bref aperçu du déploiement du ding-dong-bot à l'aide de WeChat, WhatsApp et WeCom.
Le moyen le plus rapide de démarrer avec Wechaty est d'utiliser un IDE basé sur le cloud pour exécuter le projet Wechaty Getting Started. Vous pouvez utiliser Gitpod ou Google Cloud Shell.
Si vous êtes un débutant total, nous vous recommandons Gitpod.
Gitpod est une plateforme en ligne et open source pour les environnements de développement automatisés et prêts à coder. Vous pouvez cliquer sur le bouton ci-dessous pour accéder à une configuration complète du projet Wechaty Getting Started ding-dong BOT sur gitpod. Si vous n'avez jamais utilisé gitpod auparavant, vous devrez vous connecter en utilisant votre compte gitHub.
Vous pouvez en savoir plus sur Gitpod ❤️ Wechaty sur notre blog : Commencer sans quitter votre navigateur : Wechaty ❤️ Gitpod, @huan, 06 février 2021
Google Cloud Shell est un environnement de développement et d'exploitation en ligne accessible partout avec votre navigateur. Vous pouvez exécuter ce projet sur Google Cloud Shell en cliquant sur le bouton ci-dessous.
Généré via open-in-cloud-shell
Après avoir ouvert l'éditeur Google Cloud Shell, il devrait y avoir un didacticiel ouvert dans le panneau de droite que vous pouvez suivre pour en savoir plus sur Wechaty.
Apprenez-en davantage sur l'exécution de ce projet sur Google Cloud Shell sur notre blog : Tutoriels Google Cloud Shell pour Wechaty, @huan, 20 février 2021.
Pour exécuter ce projet sur votre ordinateur local, vous devez :
Ayez Node.js v16+ installé sur votre machine. Vous pouvez exécuter la commande node -v sur le terminal pour vérifier si Node.js est installé. Si vous l'avez, vous devriez pouvoir voir la version imprimée sur le terminal comme v16.13.0 . Votre version peut être différente de v16.13.0 . S'il n'est pas installé ou si votre version est inférieure à 16, vous devez installer la dernière version en suivant les liens ci-dessous :
Node.js pour d'autres plates-formes peut être trouvé sur https://nodejs.org/en/download/package-manager/
Ayez Wechaty Puppet Service TOKEN si vous souhaitez utiliser des protocoles RPA autres que Web
Vous devez cloner ce référentiel sur votre ordinateur local, puis basculer vers le répertoire wechaty-getting-started en exécutant les commandes ci-dessous.
git clone https://github.com/wechaty/getting-started.git
cd getting-startedVous devez installer les dépendances en exécutant la commande ci-dessous.
npm install Vous pouvez utiliser export pour définir des variables d'environnement sous Linux et utiliser set sous Windows. Si vous rencontrez des erreurs lors de l'exécution de cette commande, consultez les conseils de dépannage à l'étape 4.
export WECHATY_LOG=verbose
export WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts set WECHATY_LOG=verbose
set WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.tsVous êtes prêt !
Si vous rencontrez des problèmes en suivant les étapes ci-dessus, essayez les options ci-dessous. Vous êtes également invités à poser des questions dans notre salon de discussion Gitter.
Vous pourriez également avoir besoin de Windows-Build-Tool si vous utilisez Windows :
npm install windows-build-tools Dans notre exemple de démarrage, le BOT ding-dong utilise wechaty-puppet-wechat4u lorsque WECHATY_PUPPET n'est pas défini, ce qui est juste pour la commodité du nouveau venu.
Par défaut, Wechaty utilisera le service Puppet pour vous connecter à votre bot. Vous pouvez utiliser un autre fournisseur de marionnettes comme le protocole Web Whatsapp (wechaty-puppet-whatsapp).
Si vous souhaitez utiliser un fournisseur de marionnettes Wechaty pour un protocole différent, vous devez spécifier un nom de fournisseur de services de marionnettes (identique à son nom NPM) en définissant la variable d'environnement WECHATY_PUPPET .
Grâce aux grandes contributions de notre communauté, il existe de nombreuses marionnettes Wechaty qui peuvent être utilisées par Wechaty. Ils nous ont aidés à utiliser des protocoles comme Web, Pad, Mac et Windows.
| Protocole | MNP |
|---|---|
| Service de marionnettes | wechaty-puppet-service |
| WhatsApp Web | wechaty-puppet-whatsapp |
| Web WeChat | wechaty-puppet-wechat |
| Bloc WeChat | wechaty-puppet-padlocal |
Visitez notre site Web pour en savoir plus sur les fournisseurs de services de marionnettes Wechaty.
Par exemple, si vous souhaitez utiliser la marionnette padlocal , vous devez définir WECHATY_PUPPET=wechaty-puppet-padlocal avant d'exécuter npm start . Vous avez également besoin d'un TOKEN pour wechaty-puppet-padlocal que vous devez définir sur la variable d'environnement WECHATY_PUPPET_PADLOCAL_TOKEN . Vous pouvez demander le PadLocal TOKEN à partir d’ici. Les extraits de code ci-dessous illustrent ce qui a été décrit ci-dessus sous Linux/MacOS et sous Windows.
export WECHATY_PUPPET=wechaty-puppet-padlocal
export WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm start set WECHATY_PUPPET=wechaty-puppet-padlocal
set WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm startApprenez-en plus sur l’installation de Wechaty sur Windows à partir de cet article de blog.
Ci-dessus, un didacticiel vidéo de 10 minutes. Il utilise la version 0.14 ou des versions antérieures de Wechaty, il est donc également obsolète. C'est une bonne façon de commencer si vous êtes nouveau sur Wechaty.
Remarque : Avant d'essayer d'autres exemples, assurez-vous d'avoir essayé le projet de démarrage wechaty dans ce référentiel.
https://github.com/wechaty/docker-wechaty-getting-started
https://github.com/wechaty/heroku-wechaty-getting-started
https://wechaty.github.io
Les comptes WeChat enregistrés après 2017 ne pourront pas se connecter via l'API Web. Apprenez-en plus sur wechaty/wechaty#872
Solution : Vous pouvez utiliser des protocoles de support Wechaty autres que l'API Web, tels que pad. Apprenez-en plus sur wechaty/wechaty#1296
Puppet dans WechatyLe terme Puppet dans Wechaty est une classe abstraite pour implémenter des plugins de protocole. Les plugins sont les composants qui aident Wechaty à contrôler Wechat et c'est la raison pour laquelle nous l'appelons marionnette.
Les plugins sont nommés PuppetXXX , par exemple PuppetWeChat utilise le marionnettiste de Google pour contrôler l'API Web WeChat via un navigateur Chrome, PuppetPadchat utilise le protocole WebSocket pour se connecter à un serveur de protocole afin de contrôler le programme iPad Wechat. Pour plus de détails, vous pouvez consulter Puppet dans le wiki.
Apprenez-en plus sur Wechaty Puppet grâce à notre documentation sur Wechaty Puppet
Ajoutez des exemples CQRS Wechaty.
Branche : v1.11 : version v1.11 de Wechaty.
Utiliser Google Cloud Shell pour une configuration rapide !
Utiliser Gitpod pour une configuration rapide !
Version d'initialisation
@wechaty/contributeurs
