anddreluis2 / wpp-playground

Whatsapp playground

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

wpp-playground-ai

This is a service that listens to messages from a WhatsApp group and saves them for later summarization. All saved messages are used to generate a summary using the OpenAI API.

The service is built using several technologies including TypeScript for static typing, Node.js for the runtime environment, MongoDB for database management, OpenAI for artificial intelligence capabilities, and whatsapp-web.js for interacting with WhatsApp.

The main goal of this project is to provide an efficient way to summarize group conversations, making it easier to catch up on missed discussions.

Service created using

  • typescript
  • node
  • mongodb
  • openai
  • whatsapp-web.js
  • imgflip

Prerequisites

  • An account in openai with balance to consume in the api

Run Locally

  • Clone the project
  git clone https://github.com/vinibgoulart/wpp-playground
  • Go to the project directory
  cd wpp-playground
  • Install dependencies
  yarn install
  • Copy envs
  cp .env.local .env
  • Start the server
  yarn dev
  • Read the QRCode in your whatsapp

  • Run !help to see the available commands

Run with Docker

  • Copy envs
  cp .env.docker .env
  • Run only the database
  yarn run-db
  • Run only the app
  yarn run-app
  • Run everything with docker
  yarn run-docker

About

Whatsapp playground


Languages

Language:TypeScript 97.1%Language:Dockerfile 2.1%Language:JavaScript 0.6%Language:Shell 0.1%