PredictAI - The Future of Predictive Analytics

---

📚 Table of Contents

• 🌟 Overview
• 🔧 Technologies
• 🏗 Core Areas
• 🛠 Setup and Configuration
• 💾 Data Access Layer
• 📝 Logging
• 🗄 Database
• 🖥 Development Environment
• 🗨 Communication
• 👥 Contributors

---

🌟 Overview

PredictAI is a pioneering project aimed at revolutionizing predictive analytics. Combining advanced web crawling capabilities with cutting-edge confidence engines and a versatile web service distribution center, PredictAI serves as your all-in-one analytics solution.

---

🔧 Technologies

• 🔍 Language: Golang
• 🌐 Web UI Framework: Golang for dynamic web page generation and the Unix server
• Machine Learning: CUDA
• 🗄 Database: MySQL
• 🔐 Authentication: Token-based for both users and web services
• Version Control: Git

---

🏗 Core Areas

1. 🦀 CRAB (Web Crawler/Scraper)

   • Excels in data harvesting from the web.

2. 🔮 CUDA (Confidence Engine)

   • A specialized engine delivering trustworthiness metrics on harvested data.

3. 🎣 CARP (Web Service Distribution Center)

   • Orchestrates the distribution of various web services seamlessly.

---

🛠 Setup and Configuration

• ⚙️ Configuration: All components, including Web UI, CRAB, CUDA, CARP, and DAL, are configured using a JSON file.
• The config.json file contains all the settings you'll need to get up and running.

---

💾 Data Access Layer

• 🔒 Security: DAL will interact solely with MySQL Stored Procedures (SPROCS).
• 📥 Queries: Parameterized SQL queries are employed for robust security measures.

---

📝 Logging

• 🗂️ Extensive Logs: Every action, event, and exception is meticulously logged into the MySQL Database.

---

🗄 Database

• 📜 Script: A comprehensive database setup script for initializing tables, sprocs, views, and functions.
• 🆔 Identification: GUIDs are used to uniquely identify each record.

---

🖥 Development Environment

• 🛠 IDE: JetBrains Goland is the designated IDE for all development tasks.
• Refer to the DEV_SETUP.md for specific setup instructions.

---

🗨 Communication

• 📞 Communication Platform: All team communications will be managed via MS Teams.

---

👥 Contributors

• Assali, Matthew - Team Lead
• Seitaj, Hansi
• Vejseli, Eni
• Becker, Sara
• Carpenter, Emily
• Finn, Matthew
• Green, Evan M
• Hoang, Binh Thanh
• Patel, Shiv

---

Thank you for exploring PredictAI!