Overview
The Project is a software that allows users to interact with WhatsApp through a web interface using JSON. It includes both a client and server component, built with React, Vite, TypeScript, Chakra UI, React Hook Form, Yup, Socket.io-client, Node.js, Express, Whatsapp-web.js, SocketIO, Zod, Prisma, and PostgreSQL.
Features
- React-based web interface for interacting with WhatsApp using JSON
- Server-side code for handling communication with WhatsApp API
- Integration with SocketIO for real-time messaging
- Database integration with Prisma and PostgreSQL
- Support for environment variables through .env files
- Docker Compose integration for easier deployment
- Roadmap for adding unit and integration tests and fixing mobile layout.
Installation
To install the theme, follow these steps:
Server Installation:
- Download or clone the repository.
- Enter the server folder.
- Execute
yarn installto install the dependencies. - Copy
.env.exampleto.envand set the environment variables. - Start the database container.
- Start the development server.
- Run migrations.
- Run seeds.
Web Installation:
- Download or clone the repository.
- Enter the web folder.
- Execute
yarn installto install the dependencies. - Copy
.env.exampleto.envand set the environment variables. - Start the development server.
Docker Compose Installation:
Server:
- Download or clone the repository.
- Copy
server/.env.exampletoserver/.envand set the environment variables. - Start the database container.
- Start the development container.
Web:
- Download or clone the repository.
- Copy
web/.env.exampletoweb/.envand set the environment variables. - Start the development server.
Summary
The Project is a software that allows users to interact with WhatsApp using JSON through a web interface. It consists of a client and server component and supports features such as real-time messaging, database integration, and environment variable configuration. The installation process involves setting up the server and web components separately, and it also provides a Docker Compose option for easier deployment. The project is open to contributions and has a roadmap for adding additional features and fixing issues. However, it is important to note that the software is not officially affiliated with WhatsApp and usage may come with potential risks. Contact details for support and further information are provided.