Giter Club home page Giter Club logo

whatsappclient's Introduction

WhatsAppClient

This is a TypeScript project for creating a client for the WhatsApp Web API. It allows to interact with the API and perform operations like sending messages, checking authentication status and retrieving QR code.

Prerequisites

  • Node.js and npm installed on your machine
  • A device with WhatsApp installed and open
  • QR code of the WhatsApp to be able to authenticate

Installation

  1. Clone the repository
  2. Run npm install in the project folder to install all dependencies

Running the server

  1. Run npm start to start the server
  2. The server will be running on http://localhost:3000

API endpoints

  • GET /sendMessage/:number/:text: Sends a message to the specified number with the specified text
  • GET /isAuthenticated: Returns the authentication status of the client
  • GET /getQr: Returns the QR code for authentication

Code structure

  • src/app.ts: Entry point of the application. It sets up the express app and listens to the specified port
  • src/controller.ts: Handles the routes and delegates the work to the WhatsAppClient
  • src/WhatsAppClient.ts: The main client which interacts with the WhatsApp Web API. It implements the singleton pattern to ensure that only one instance of the client is created.

Contributing

If you wish to contribute to the project, feel free to create a pull request. Make sure your changes are well-documented and well-tested.

whatsappclient's People

Contributors

jacobo0312 avatar hosttwototango avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.