ContactBridge

Log | Files | Refs | README

README.md (2386B)

      1 # ContactBridge
      2 
      3 ContactBridge is a web platform designed to seamlessly integrate with existing websites, enabling them to set up and receive messages from contact forms efficiently. Built with a focus on simplicity and functionality, ContactBridge offers a streamlined process for managing contact form submissions, including spam detection, storage, and notification functionalities.
      4 
      5 ## Technologies
      6 
      7 ContactBridge leverages a robust stack of technologies to ensure a seamless, efficient, and scalable service:
      8 
      9 - **Flask**: A lightweight WSGI web application framework in Python, enabling rapid development and server management.
     10 - **RestXT (with OpenAPI UI)**: Provides a straightforward, standards-based way to define and expose RESTful APIs, complete with interactive documentation through OpenAPI UI.
     11 - **MaterializeCSS**: A modern responsive front-end framework based on Material Design, ensuring an intuitive and responsive admin portal.
     12 - **HTMX**: Offers dynamic interactions with the web pages, enhancing the user experience without requiring complex JavaScript frameworks.
     13 - **SQLite**: Currently utilized for the lightweight and serverless database needs, ensuring quick setup and ease of message storage.
     14 - **MySQL**: Planned migration for enhanced scalability and performance in handling larger datasets.
     15 
     16 ## Sequence Diagram
     17 
     18 The following sequence diagram illustrates the workflow of ContactBridge from message submission to processing and notification.
     19 
     20 ![Sequence Diagram](/assets/sequenceDiagram.svg)
     21 
     22 ## Usage
     23 
     24 ### Integrating ContactBridge
     25 
     26 To integrate ContactBridge into your website, follow these steps:
     27 
     28 1. Include a reference to the ContactBridge script in your website's HTML.
     29 2. Configure the contact form to point to the ContactBridge endpoint.
     30 3. Customize the settings in the ContactBridge admin portal to match your website's needs.
     31 
     32 ### Admin Portal
     33 
     34 The admin portal allows administrators to:
     35 
     36 - View all received messages in a centralized dashboard.
     37 - Configure email notification settings.
     38 - Manage spam filters and review messages categorized as spam.
     39 
     40 ## Future Plans
     41 
     42 - **Database Migration**: Transitioning from SQLite to MySQL for improved performance and scalability.
     43 - **Enhanced Spam Detection**: Implementing more sophisticated algorithms for spam detection to reduce false positives and ensure important messages are promptly delivered.