Skip to content

Commit 407c3a0

Browse files
authored
Merge pull request #47 from Jalen-Stephens/46-iteration-1-final-deliverable
Final Deliverable for Iteration 1
2 parents 3560308 + badcb7f commit 407c3a0

File tree

9 files changed

+36
-71
lines changed

9 files changed

+36
-71
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ From the terminal, run the following CLI commands:
6767

6868
## Running the Application with Docker
6969
---------------------------------------------------------------------
70+
STILL UNDER DEVELOPMENT - PUSH TO ITERATION 2 - Sulay has been working very hard on this and it's good for next iteration
7071

7172
### 🐳 What is Docker?
7273
Docker packages your application and its dependencies into a container so that it runs identically across any environment. It’s a portable and lightweight runtime environment — ideal for ensuring consistent deployments.
@@ -275,6 +276,8 @@ Cd in to code directory
275276
Ran to generate report:
276277
$HOME/pmd-bin-7.16.0/bin/pmd check -d src/main/java,src/test/java -R rulesets/java/quickstart.xml -f text -r pmd-report.txt
277278

279+
You can also run `mvn clean verify` to run pmd and test
280+
278281

279282

280283
## MetaDetect Endpoints
@@ -468,13 +471,39 @@ I used PMD to perform static analysis on my codebase, see below for the most rec
468471

469472
![Screenshot of PMD analysis report](reports/pmd-report.png)
470473

474+
## Proof of Multiple Test Users in DB
475+
We tested with two users uploading the same exact image to see if it caused conflicts, there were no conflicts and images were store sperately within DB.
476+
477+
![Screenshot of DB Table](reports/two-users-proof.jpg)
478+
479+
## Proof of Images stored in Supabase Bucket
480+
Wanted to show proof of Objects stored in DB.
481+
482+
![Screenshot of DB Bucket with Image](reports/objects-stored-DB.jpg)
483+
484+
## Proof of API Testing using Postman
485+
Used Postman and Curl to Test our API routes
486+
487+
![Screenshot of Postman Testing](reports/api-testing.png)
488+
489+
## Proof of Self-Documenting Code
490+
Had a Ticket Dedicated to Going through each file and Ensuring there was javadocs and inline comments:
491+
[[Chore] - Write JavaDoc comments for all non-trivial code #35](https://github.com/users/Jalen-Stephens/projects/5/views/1?pane=issue&itemId=135291288&issue=Jalen-Stephens%7CAdvanceJavaStudentEngineers%7C35)
492+
493+
## Documentation of AI Resources
494+
Where AI was used it was heavily documented in the [citations.md](https://github.com/Jalen-Stephens/AdvanceJavaStudentEngineers/blob/main/citations.md)
495+
496+
## Project Management Tool
497+
We used [Github Projects Kanban Board](https://github.com/users/Jalen-Stephens/projects/5) to Track development.
471498

472499
## Continuous Integration Report
473500
---------------------------------------------------------------------
474-
This repository using GitHub Actions to perform continous integration, to view the latest results go to the following link: https://github.com/Jalen-Stephens/AdvanceJavaStudentEngineers/actions
501+
This repository using GitHub Actions to perform continous integration, to view the latest results go to the following link: [AdvanceJavaStudentEngineers/actions](https://github.com/Jalen-Stephens/AdvanceJavaStudentEngineers/actions)
475502

476503
Click on the latest job on the top under "X workflow runs" then Click 'build' under jobs finally click the drop down next to all the action items to read the logs made during their execution.
477504

505+
STILL UNDER DEVELOPMENT - PUSH TO ITERATION 2 - Sulay has been working very hard on this and it's good for next iteration
506+
478507
## Tools used
479508
---------------------------------------------------------------------
480509
This section includes notes on tools and technologies used in building this project, as well as any additional details if applicable.
@@ -498,4 +527,9 @@ This section includes notes on tools and technologies used in building this proj
498527
* We use the open-source c2patool to scrape manifest metadata for determining the usage of AI in generating an image.
499528
* Coalition for Content Provenance and Authenticity (C2PA). *c2patool (Version 0.23.4)*.
500529
* Content Authenticity Initiative, Adobe Systems, 2024.
501-
* Available at: https://github.com/contentauth/c2pa-rs
530+
* Available at: https://github.com/contentauth/c2pa-rs
531+
* Supabase (Postgres SQL)
532+
* We use Supabase as our main Database
533+
* It has built in Authentication
534+
* We use tables to track metadata of images
535+
* Then we use S3 Buckets to store the physical Images within Supabase

citations.md

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,3 @@
1-
### **Commit / Ticket Reference**
2-
- **Commit:** `<your commit message>`
3-
- **Ticket:** `#<ticket number> — <ticket title>`
4-
- **Date:** <month day, year>
5-
- **Team Member:** <name>
6-
7-
---
8-
9-
### **AI Tool Information**
10-
- **Tool Used:** OpenAI ChatGPT (GPT-5)
11-
- **Access Method:** ChatGPT Web (.edu academic access)
12-
- **Configuration:** Default model settings
13-
- **Cost:** $0 (no paid API calls)
14-
15-
---
16-
17-
### **Purpose of AI Assistance**
18-
<Briefly describe what part of the task the AI assisted with — e.g., refactoring, writing docs, fixing errors, setting up build tools, etc.>
19-
20-
---
21-
22-
### **Prompts / Interaction Summary**
23-
<List or paraphrase the key prompts you used.>
24-
25-
---
26-
27-
### **Resulting Artifacts**
28-
<List files, configurations, or code generated/edited with AI help.>
29-
30-
---
31-
32-
### **Verification**
33-
<List how you tested/validated the AI-assisted changes (build, test suite, manual review, etc.).>
34-
35-
---
36-
37-
### **Attribution Statement**
38-
> Portions of this commit or configuration were generated with assistance from OpenAI ChatGPT (GPT-5) on <date>. All AI-generated content was reviewed, verified, and finalized by the development team.
39-
40-
---
41-
421
### **Commit / Ticket Reference**
432

443
* **Commit:** `chore(init): renamed project to MetaDetect, updated package structure, pom.xml coordinates, and Spring Boot configuration (#2)`

deployment.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

honesty.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

reports/api-testing.png

324 KB
Loading

reports/branch-report.png

-42.4 KB
Loading

reports/checkstyle-report.png

-108 KB
Loading

reports/objects-stored-DB.jpg

254 KB
Loading

reports/two-users-proof.jpg

261 KB
Loading

0 commit comments

Comments
 (0)