Contact

For any questions, feel free to reach out on Discord: All projects will be delivered and paid via fiverr.

Objective Dev 2

The main task is to implement a a chat-ui page and integrate a Go WhatsApp Web API backend into the LizAnt UI React template provided. This is an integration project requiring webhook and api endpoint work to link the WhatsappAPI service to a web-UI chat page. There are other people working on this project who can assist with various tasks such as K8 deployment and data modelling and sql work. Your work needs to be in scope - Implement the chat functionality.

Stack

• Backend - Golang (Fiber + GORM)
• Frontend - ReactJS
• Architecture - K8 + NGINX / Traefik
• Database - PostgreSQL

Chat Deliverables:

• A K8 + ingress controller configuration for whatsapp chat API service (comms-api)
• Configure endpoints and link the LizAnt cat UI template to comms-api thrugh ingress.
• PostgreSQL database configuration for chat related data shared between users.

Architecture Description

The application architecture is designed to be modular and scalable, leveraging microservices and containerization. Here is a detailed description of each component:

Proposed Architecture Components

1. main-frontend:

   • We are using the LizAnt react template - https://ur0.jp/i23Kz
   • See templates inside ./templates/
   • Uses main-frontend/api/ endpoint

2. main-backend:

   • Manages user sessions, authentication
   • Uses company/api/v1/ endpoint

3. comms-api:

   • Manages chat functionality, including message storage, retrieval, and real-time updates.
   • Integrates with the existing Go backend for user authentication.
   • @asternic/wuzapi
   • WuzAPI - an implementation of @tulir/whatsmeow library as a simple RESTful API service with multiple device support and concurrent sessions.
   • Uses comms-api/api/whatsapp/ endpoint

4. Database (PostgreSQL):

   • Stores user data, chat messages, and other related information.

5. Controller:

   • Manages and routes requests to the appropriate services. you can use nginx for dev but traefik is the final solution.
   • https://hub.docker.com/_/traefik

6. K8:

   • Manages multi-container Docker applications.
   • You should be able to deploy locally using Minikube.

Chat Scenarios / Functionality

There is an organization with multiple users using the React web-app. You can assume all users are admins.

1. Register WhatsApp web - The user must log in and receive a QR code to register WhatsApp web. Users authenticated in main-backend. There are multiple users each with unique whatsapp.
2. De-Register WhatsApp web - The user must be able to de-register WhatsApp web.
3. Cat Load and Contact Merge - WhatsApp web API is called to retrieve all contacts and historical chats. There is a pre-existing contacts table available in MySQL. The engine must join the data sets by phone numbers and identify matches.
4. Multiple Users - Multiple users use the same WhatsApp backend and are able to use the chat functionality offered by WuzAPI.
5. Decoupled Backends - We have the main-backend in Go which powers use authentication only. The WhatsApp API (comms-api) should be implemented as an independent service with own endpoint.
6. Postgres DB - By default, WuzAPI is configured to use SQLite, but this implementation of @tulir/whatsmeow library also supports PostgreSQL. A separate container running PostgreSQL must be deployed to support any CRUD operations from WuzAPI.
7. User Chat View - Other users in the organisations can't see others conversations BUT a user can give read-only access to another user to one of his own chats.

Chat Frontend Functions

• Modify the chat box for better screen fit.
• Add a favorites section to pin contacts.
• Enhance the contact card to integrate user-specific information and tags from the database (we need to display a database 'Tag' and basic contact info on left pane. see screenshot below with dashed line in red.
• Admin Screen: There is a Profile page already available. YAdd section where user can request a QR code and register their WhatsApp.

• Chat App: Develop a chat application for users to communicate. Ensure it can handle 3-4 concurrent users.

MySQL Schema Credentials with Data Example

You can check some dummy data and data model using the credentials here but everything will be migrated to PostgreSQL.

User: `engadev`
Password: `userengadev`
Host: `45.8.149.43:3306`
Schema: `data_feeds`

Notes on the Data

1. You can deploy a copy of the database locally by running db/db_dump_file.sql.
2. Once the cat app is connected via QR code, it should automatically pull in and populate the contact_whatsapp table with all available contacts from WhatsApp.
3. The table tag_ref includes available tags which should be fed into the contact card - see Enhance the contact requirements in the frontend section.
4. There is a tag_id field in contact_ref which should be displayed on the contact card in the chat app.
5. All chat data should be stored.
6. There are 3 available users in user_ref and they provide the login credential information for the web app.
7. Be able to add a contact from the chat app via the + button; this should populate contact_ref.