diff --git a/README.md b/README.md index bdcab126..d76a192c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -![image]()GND Logo +GND Logo -[![codecov](https://codecov.io/github/COS301-SE-2024/GDPR-data-noncompliance-detector/graph/badge.svg?token=nEPpXWGssM)](https://codecov.io/github/COS301-SE-2024/GDPR-data-noncompliance-detector) -![GitHub issues](https://img.shields.io/github/issues/COS301-SE-2024/GDPR-data-noncompliance-detector) -![GitHub pull requests](https://img.shields.io/github/issues-pr/COS301-SE-2024/GDPR-data-noncompliance-detector) +

+ + codecov + + GitHub issues + GitHub pull requests +

@@ -14,7 +18,28 @@ This project is a GDPR Data Noncompliance Detector, developed as part of the COS The GDPR Data Noncompliance Detector is a software tool designed to identify instances of noncompliance with the General Data Protection Regulation (GDPR). It analyzes data sets and identifies potential violations of GDPR principles, such as unauthorized data processing, inadequate security measures, or lack of consent. -## Demos + +https://github.com/user-attachments/assets/a5979f3e-41be-493e-b4c0-0d5f4b0442e1 + +## Final Project Video + +[Final Video](https://drive.google.com/file/d/1r_lsk7uXM3fbUaJqfcGsSLvVjqhFFfv3/view?usp=drive_link) + +# Download the GND Application + +Download GND -> [📥](https://drive.google.com/file/d/1WV0WCWq1VSLAgREVHJ523JzclZXMwBnW/view?usp=sharing) + +### Download Instructions + +Step 1: Click on the link to download the GND application Installer. + +Step 2: Follow the instructions in the installation wizard to install the application on your computer. + +Step 3: After the application is installed, you will need to restart your computer. + +Step 4: After your computer has restarted, you will receive a notification, indicating that the GND server has started and you will be able to use the application. + +## Demo Links ### Demo 1 [Demo 1 SRS Documentation](https://me-qr.com/mobile/pdf/22767945) @@ -40,18 +65,13 @@ The GDPR Data Noncompliance Detector is a software tool designed to identify ins

[Demo 4 Testing Specification](https://github.com/COS301-SE-2024/GDPR-data-noncompliance-detector/blob/develop/documentation/Demo_4___Testing_Specification.pdf)

-# Download +## Project Summary -[https://drive.google.com/drive/folders/1LANx27MNDwmfvDtj09NFvJ05s91Ya-7n?usp=sharing](https://drive.google.com/file/d/1WV0WCWq1VSLAgREVHJ523JzclZXMwBnW/view?usp=sharing - - -#Demo 4 Input - -[Submit Personal Data](https://docs.google.com/spreadsheets/d/1_c1JbehTnfNju1iyqR2vt_2np4OUfFGkX9SmGOiEvco/edit?usp=sharing) +[Project Summary](https://www.canva.com/design/DAGUJc0wt2k/LNiWKUgbstDVH-GZvOIMhw/edit?utm_content=DAGUJc0wt2k&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton) # Documentation - + ## Software Requirements Specification [SRS Document](https://github.com/COS301-SE-2024/GDPR-data-noncompliance-detector/blob/develop/documentation/Demo_3___SRS.pdf) @@ -67,7 +87,7 @@ The GDPR Data Noncompliance Detector is a software tool designed to identify ins [Coding Standards](https://github.com/COS301-SE-2024/GDPR-data-noncompliance-detector/blob/develop/documentation/Coding_Standards.pdf) ## User Manual -[GND User Manual](https://github.com/COS301-SE-2024/GDPR-data-noncompliance-detector/blob/develop/documentation/GND%20Manual_V2.pdf) +[GND User Manual](https://github.com/COS301-SE-2024/GDPR-data-noncompliance-detector/blob/develop/documentation/GND_Manual_V3.pdf) ## Machine Learning Training Specification [AIML_Spec.pdf](https://github.com/user-attachments/files/17433721/AIML_Spec.pdf) @@ -79,122 +99,144 @@ GitHub Issues and GitHub Boards ## The Team ### Dhinaz Rangasamy - +
- + - - + +
- + + + +

Role: Team Leader/Backend Engineer

- Github + Github +
- Linkedin + Linkedin

-

Role: Team Leader/Backend Engineer

- 		-

Dhinaz is currently pursuing Computer Science, Statistics and Data Science. He has worked with multiple technologies relating to all fields, and is especially interested in AI, ML and regression applications. He has completed multiple design and research projects related to data analysis and software modelling, two of which are linked above. He is also self-taught in Tableau and is currently working as a teaching assistant for COS 221 (Introduction to databases) at the University of Pretoria.

+
+

Dhinaz is currently pursuing Computer Science, Statistics, and Data Science. He has worked with multiple technologies relating to all fields and is especially interested in AI, ML, and regression applications. He has completed multiple design and research projects related to data analysis and software modeling, two of which are linked above. He is also self-taught in Tableau and is currently working as a teaching assistant for COS 221 (Introduction to databases) at the University of Pretoria.
### Nevin Thomas - +
- + - - + +
- + + + +

Role: Designer/Frontend Engineer

- Github + Github +
- Linkedin + Linkedin

-

Role: Designer/Frontend Engineer

- 		+

As a third-year BSc Information and Knowledge Systems student, I specialize in merging technology and business insights to craft captivating social media web apps. Proficient in front-end development technologies like React, Ionic, and Angular, I implement innovative solutions efficiently. My passion for design enhances user experiences, reflecting in my projects where I prioritize intuitive interfaces and engaging interactions. A natural team player, I excel in collaborative environments, leading and contributing with determination and an open mind. Continuously refining my skills in front-end development, I am poised to make a significant impact in technology and enterprise.
- ### Yeshlen Moodley - +
- + - - + +
- + + + +

Role: Backend Engineer/DevOps

- Github + Github +
- Linkedin + Linkedin

-

Role: Backend Engineer/DevOps

- 		-

I am a final year BSc Information and Knowledge Systems student. This degree has allowed me to gain invaluable experience in not only the fields of computer science but statistics and data analytics as well. I have a vested interest in the field of data science and using the insights that can be gained from analysing a system, to optimise it as much as possible. I have experience in building comprehensive web and desktop applications and have worked on the frontend side of development for multiple projects.

+
+

I am a final year BSc Information and Knowledge Systems student. This degree has allowed me to gain invaluable experience in not only the fields of computer science but also statistics and data analytics. I have a vested interest in the field of data science and using the insights that can be gained from analyzing a system to optimize it as much as possible. I have experience in building comprehensive web and desktop applications and have worked on the frontend side of development for multiple projects.
### Yudi Govender - +
- + - - + +
- + + + +

Role: Backend Developer/DevOps

- Github + Github +
- Linkedin + Linkedin

-

Role: Backend Developer/DevOps

- 		-

I am a final year Computer Science student at the University of Pretoria. My degree has exposed me to many computer science concepts. In web development I enjoy backend and API development. I also enjoy learning about the field of graphics programming. I have a keen interest in machine learning and AI. With my knowledge I aim to aid my team with the skills I have learnt in graphics and data visualisation.

+
+

I am a final year Computer Science student at the University of Pretoria. My degree has exposed me to many computer science concepts. In web development, I enjoy backend and API development. I also enjoy learning about the field of graphics programming. I have a keen interest in machine learning and AI. With my knowledge, I aim to aid my team with the skills I have learnt in graphics and data visualization.
### Paul Nhlapo - +
- + - - + +
- + + + +

Role: Full Stack Developer

- Github + Github +
- Linkedin + Linkedin

-

Role: Full Stack Developer

- 		-

I am a final year BSc Information and Knowledge Systems (Software development) student. I major in Computer Science in my degree, and I have explored all sides of software engineering processes from first year till now. I have learnt a lot from this degree, and it has exposed me to systems analysis and in-depth web development, problem solving using data structures in (Java and C++) and systems development. I have experience with .NET technologies and have worked with C#. Currently I work with ionic and Angular for my final year modules.

+
+

I am a final year BSc Information and Knowledge Systems (Software development) student. I major in Computer Science in my degree, and I have explored all sides of software engineering processes from first year till now. I have learnt a lot from this degree, and it has exposed me to systems analysis and in-depth web development, problem solving using data structures in (Java and C++) and systems development. I have experience with .NET technologies and have worked with C#. Currently I work with ionic,Python and Angular for my final year modules.
+## Research (Additional Information) + +Our project aimed to contribute to GDPR compliance by designing a system that detects potential data violations in documents. We conducted extensive research on GDPR requirements using trusted resources like [www.GDPR.eu](GDPR.eu) , [www.gdpr-info.eu](gdpr-info.eu) and [www.popiact-compliance.co.za](www.popiact-compliance.co.za). The system leverages natural language processing (NLP) and machine learning to scan documents for multiple categories of GDPR-protected data. It alerts users to potential violations, promoting compliance with European data protection regulations. + +The project's research contribution lies in applying machine learning models to the specific context of GDPR. We explored AI frameworks to improve the accuracy of identifying sensitive information and developed a scalable, modular system architecture. +Our research allowed us to narrow down the broadness of GDPR non-compliant data into categories that suited our project best. The categories we chose to identify are ones we believe to be the most common in text based documents. + + ## Team Contact Email: aprilfour301@gmail.com @@ -202,13 +244,48 @@ Email: aprilfour301@gmail.com ## Tech Stack ### Frontend -Angular with Electron + + + + + + + + + + +
Angular IconAngular is used for building the frontend interface and handling client-side logic.
Electron IconElectron is used to package the Angular application into a desktop app.
### Backend -Python -FlaskAPI + + + + + + + + + + +
Python IconPython is used for scripting and backend development.
Flask IconFlask is used to create RESTful APIs and manage backend logic.
### Testing -PyTest -Karma -Jasmine + + + + + + + + + + + + + + +
PyTest IconPyTest is used for writing and running unit tests for the backend.
Karma IconKarma is used as a test runner for Angular applications.
Jasmine IconJasmine is used for writing unit tests in JavaScript, commonly with Angular.
+ + + + diff --git a/documentation/GND aprilfour.mp4 b/documentation/GND aprilfour.mp4 new file mode 100644 index 00000000..fc05b18b Binary files /dev/null and b/documentation/GND aprilfour.mp4 differ diff --git a/documentation/GND_Manual_V3.pdf b/documentation/GND_Manual_V3.pdf new file mode 100644 index 00000000..6ef82dc7 Binary files /dev/null and b/documentation/GND_Manual_V3.pdf differ