CS4311_INFILTR8_6TheNine-Bytes_Fall2024

🤖 SW2 INFILTR8 Development Repo (FINALIZED)

(Course Work) Breathing Implementation of the INFILTR8 system created by The Nine Bytes team. This is based on the finalized SRS and is to be finished at the end of the FALL 2024 Semester. [🧠]

🔎 Table of Contents.

1. Team Composition. [The Nine-Bytes]
2. Guidance Team & Customer Information. [DEVCOM]
3. What Files are Enclosed Here?
4. Tech Stack Foundation.
5. Install Instructions.
6. Project Milestones & Video Demonstrations.

🎏 Team Composition. [The Nine-Bytes]

This Project was completed through the cooperation of nine team members!

Gilbert I. Guzman - Team Lead/Analyst/Repo Master: Created GitHub Repo, Communicated with Staff, Bugfixed code, Programmmed Colorblind Filters, Programmed Universal Fonts, Wrote Manual, Programmed Settings Page, Programmed Support Page, Programmed Analysis Page, Recorded Demo Videos.

Alberto Villegas - Quality Manager/Programmer: Assisted In Creation of all UX, Bugfixed code, Collaborated on Reports UI, Assisted with Project Manager Frontend, Report Frontend.

Brian Mata - Dataflow & Business Manager/Programmer: Assisted In Creation of all UX, Bugfixed code, Created Database, Programmed Darkmode, Programmed Backend for login, Programmed Pulling/Pusing of data to database, Bugfixing for Sprint #4.

Christian Garcia - Quality Manager/V&V: Assisted In Creation of all UX, Bugfixed code, Readme Assistance and Commentation, Assisted in settings UI, Analysis Page Backend.

Christian Revilla - Analysis Manager/Programmer: Assisted In Creation of all UX, Bugfixed code, Programmed Frontend for login, Programmed Routing of svelte pages, Taught teammates tailwind, Bugfixing for Sprint #4.

Janelle Guzman - Customer Interface Manager/Designer: Assisted In Creation of all UX, Bugfixed code, Assisted in backend logs, assisted with website design aethetics, Logs Page Frontend.

Jose Luis Rojas - Bahavioral Model Manager/Designer: Assisted In Creation of UX, Bugfixed code, Assisted in frontend logs, assisted with initial database prototyping, Logs Page Backend.

Kimberly Kocian - Support Manager/V&V: Assisted In Creation of all UX, Bugfixed code, Assisted with Project Manager frontend, assisted with svelte routing, Project Manager fixing.

Luis Sanchez - Planning Manager/Analyst: Assisted In Creation of all UX, Bugfixed code, Assisted with Project Manager Backend, general formatting, Reports Backend.

Special Thanks to All of those who contributed! We could not do it without you!

🎖️ Guidance Team & Customer Information. [DEVCOM]

The following individuals are the guidance team for the development of INFILTR8. They are:

• Dr. Salamah Salamah - Manager

• Scott R. Ledford - TA

• Consuelo Ramirez – TA

This Project is being worked on at the behest of the U.S. Army Combat Capabilities Development Command, also known as DEVCOM.

Our official customer list includes:

• Sebastian Quinones  

• Diana Ramirez  

• Timothy Hannan  

• Lucia Rodriguez-Melgoza  

• Thomas Tenorio  

• Miriam Olague 

*Team #6 extends its sincere gratitude to all of our customers and our guidance team! Thank you for believing in us!*

🗂️ What Files are Enclosed Here?

The following table shows the files currently stored on this repo, which have been used for the development and use of INFILTR8.

Filename	Type	Description
.vscode	🗂️	settings.json for use in VSCode.
Gil-Test-Resources	📦	[Depricated]. Contained early pre-fixed files to run the .nessus file. maing.py has been modified to handle new inputs and get a sample output. This is not the final version, and existed only for testing backend!
INFILTR8	🗂️	Contains files necessary to build and run INFILTR8, including its backend and GUI.
Initial-Dependecies-And-Resources	🗂️	Contains main source code, sample broken .nessus file, the finalized SRS, and some diagrams. These files will help kickstart development.
my-app	📦	[Depricated]. Contained files necessary to build and run earlier versions of INFILTR8, on the old naming scheme so no longer used.
.gitignore	.txt	File that contains what should be ignored when committing to GitHub. We dont carry logs or .env, for example.
README	.md	All of the text that you are currently reading.
install	.sh	Shell-script that installs the system for you. (Linux Only)
.package-lock	.json	Contains a snapshot of your entire dependency tree for Node.js.
.package	.json	Contains the snapshot of the Node.js databse.

The following file was created as a "Bonus Presentation" for the INFILTR8 Project. It wasn't a requirement, but was made as a last hurrah for this project.

Filename	Type	Description
Team6_TheNineBytes_INFILTR8_FinalPresentation	📊	.pptx containing our bonus presentation. Shows final video demo & Team #6's thoughts on developing INFILTR8.

🖥️ Tech Stack Foundation.

The following table shows the technology to be used to develop INFILTR8, taken explicitly from the given SRS document.

Name	Type	Version	Description
Github	Version Control	-	A web-based platform for version control and collaboration, using Git for managing code repositories. Will be used to store INFILTR8 as it develops.
Neo4j Aura	Database	v3.5	Cloud Based graph database management system designed to store and query complex relationships between data. [Used for Backend].
Node.js/JS	Runtime Environment	v20.17.0	Chrome based runtime environment built on JavaScript, versatile scripting language primarily used for web development to create interactive effects within web browsers. [Used for Site].
npm	Package Manager	v10.9.0	Package manager for Node.js. [Used for Code].
Python	Langauge	v3.12.7	High-level, interpreted programming language known for its readability and versatility. [Used for Code].
Svelte	Framework/Library	v5.0	Front-end framwork for building web applications compiling components to highly efficient JavaScript. [Used for making Site Contents].
Tailwind	CSS Framework	v3.0	Utility-first CSS framework for rapidly building custom user interfaces. [Used for Frontend].
Typescript	Language	-	Superset of JavaScrpt that adds static types.
Vite	Build Tool	-	A build tool that provides a fast environemnt for web projects.
XML	Language	-	Markup language designed for storing and transporting data in configuration files.

💾 Install Instructions.

• After pulling GitHub code (via your preferred method), open the terminal and input the following:

1. cd into the folder called "INFILTR8":

   cd INFILTR8

2. Start INFILTR8:

   npm run dev

*Legacy Instructions (Pre-Final Build)*

• After pulling GitHub code (via your preferred method), open two terminal in Split View.

  A. In terminal #1.

  1. cd into the folder called "INFILTR8":

     cd INFILTR8

  2. Install dependencies

     npm i

  3. Fund if prompted to:

     npm fund

  4. Build INFILTR8:

     npm run build

  5. Start INFILTR8:

     npm run dev

  B. In terminal #2.

  1. cd into the folder called "INFILTR8":

     cd INFILTR8

  2. cd into the folder called "server":

     cd server

  3. Run the database:

     node server.js

  C. You can also use the install script if you’ve downloaded the source code from GitHub as a ZIP file.

  1. Run Install Script for Linux:

     ./install.sh

🎞️ Project Milestones & Video Demonstrations.

Short video archives demonstrating the various vertical slices for INFILTR8 have been recorded to show the software design process.

• DEMO #1 - README & GitHub Update, Non-Functional GUI, Data Storage, GitHub Configuration, DAC Added to GitHub, Stack Foundation & Project Dashboard.

• Due: [9/16/24].

• [Shipped ✅].

  • https://youtu.be/wsV8tB8XbOw

• DEMO #2 - README & GitHub Update, Improved Database, Processing Recon Data, Allowed/Off-limit IP List, Entry Point Types Selection, & Start of Logs.

• Due: [9/30/24].

• [Shipped ✅].

  • https://youtu.be/GIlSGcYOIUc

• DEMO #3 - README & GitHub Update, "AI Algorithm" Integration, GUI Update, Database Update, & Logs Update.

• Due: [10/18/24].

• [Shipped ✅].

  • https://youtu.be/xTV-pyUmyZs

• DEMO #4 - README & GitHub Update, AI Algorithm Integration (Finalized), Analysis Page Execution, Analysis Progress Display, Upload .nessus via GUI, & Logs Update.

• Due: [10/28/24].

• [Shipped ✅].

  • https://youtu.be/cFGu_UDyXlM

• DEMO #5 - README & GitHub Update, View Analysis Results, Export Analysis Results, Anaysis Scheduling, Filter Results.

• Due: [11/13/24].

• LIVE DEMO: [11/13/24].

• [Shipped ✅].

  • https://youtu.be/QIqKvX47Tqg

• DEMO #6 - README & GitHub Update, INFILTR8 Installer, All Tech Debt Resolved, Clean GitHub Repo, Final Demo Video.

• Due: [12/2/24].

• [Shipped ✅].

  • https://youtu.be/TogXvEa8B3M?feature=shared