Modify README.md and add new images

Author: Warren-SJ

README.md

@@ -1,178 +1,15 @@
-# Apex Grid
+# 🚀 Apex Grid
 
-## Live app
+## 🌐 Live app
 
 - Production (deployed): <https://apex-grid-transformer-tracker.vercel.app/>
-- Want to run everything locally? Use the below instructions
+- Want to run everything locally? Check the local branch
 
-Next.js App Router frontend with a Spring Boot backend (preferred). Legacy Next.js API + Prisma/SQLite remains available for local only.
-
-- Frontend: Next.js (App Router), React, Tailwind
-- Backend: Spring Boot (Web, Data JPA, Security), postgres
-
-## Prerequisites
-
-- Frontend
-  - Node.js 18+ (20+ recommended)
-  - pnpm (preferred). One-time install: `npm i -g pnpm`
-- Backend (Spring Boot)
-  - Java 21
-  - Maven 3.9+
-
-## Run locally (Spring backend + Next.js frontend)
-
-Make sure the database is running and accessible. Schema is given below
-
-```sql
-
-create table public.inspections (
-  id text not null,
-  transformer_id text not null,
-  inspectionnumber text not null,
-  inspecteddate text null,
-  maintainancedate text null,
-  branch text null,
-  status text null,
-  imageurl text null,
-  weather text null,
-  lastanalysisweather text null,
-  uploadedby text null,
-  imageuploadedby text null,
-  imageuploadedat timestamp with time zone null,
-  favourite boolean not null default false,
-  boundingboxes text null,
-  faulttypes text null,
-  faulttypehistory text null,
-  boundingboxhistory text null,
-  annotatedby text null,
-  annotatedbyhistory text null,
-  severity text null,
-  timestamphistory text null,
-  timestamp timestamp with time zone null,
-  severityhistory text null,
-  constraint inspections_pkey primary key (id),
-  constraint inspections_inspectionnumber_key unique (inspectionnumber),
-  constraint fk_inspections_transformer foreign KEY (transformer_id) references transformers (id) on delete CASCADE
-)
-
-create index IF not exists idx_inspections_transformer_id on public.inspections using btree (transformer_id) TABLESPACE pg_default;
-
-create table public.transformers (
-  id text not null,
-  region text null,
-  transformernumber text not null,
-  polenumber text null,
-  type text null,
-  location text null,
-  sunnyimage text null,
-  cloudyimage text null,
-  windyimage text null,
-  uploadedby text null,
-  sunnyimageuploadedby text null,
-  cloudyimageuploadedby text null,
-  windyimageuploadedby text null,
-  sunnyimageuploadedat timestamp with time zone null,
-  cloudyimageuploadedat timestamp with time zone null,
-  windyimageuploadedat timestamp with time zone null,
-  favourite boolean not null default false,
-  constraint transformers_pkey primary key (id),
-  constraint transformers_transformernumber_key unique (transformernumber)
-)
-
-CREATE TABLE public.users (
-  id CHARACTER VARYING NOT NULL,
-  username CHARACTER VARYING NOT NULL UNIQUE,
-  passwordhash TEXT NOT NULL,
-  createdat TIMESTAMP WITH TIME ZONE NOT NULL,
-  image TEXT,
-  CONSTRAINT users_pkey PRIMARY KEY (id)
-);
-
-CREATE TABLE public.ai_model_parameters (
-  param_key text not null,
-  param_value double precision not null,
-  updated_at timestamp with time zone not null default now(),
-  constraint ai_model_parameters_pkey primary key (param_key)
-) TABLESPACE pg_default;
-
-CREATE TABLE public.ai_tuning_feedback (
-  id uuid not null default gen_random_uuid (),
-  inspection_id text not null,
-  ai_box_count integer not null,
-  user_box_count integer not null,
-  box_diff integer not null,
-  created_at timestamp with time zone not null default now(),
-  previous_snapshot text null,
-  final_snapshot text null,
-  previous_faults text null,
-  final_faults text null,
-  previous_annotated text null,
-  final_annotated text null,
-  notes text null,
-  constraint ai_tuning_feedback_pkey primary key (id)
-) TABLESPACE pg_default;
-
-```
-
-### Recommended method: Use Docker for the backend
-
-1. Create a `.env` file in the `backend/` directory based on `.env.example` with your DB credentials.
-
-2. Build and run the Docker container
-
-```powershell
-# from the project root
-cd backend
-docker pull warrensjk/transformer-tracker:latest
-docker run -d --env-file .env -p 8080:8080 --name transformer-tracker warrensjk/transformer-tracker:latest
-```
-
-### Alternative method: Run the backend directly with Maven
-
-1. Install python dependencies for the AI model
-
-```powershell
-# from the project root
-cd backend/AI
-pip install -r requirements.txt
-```
-
-2. Start the backend (port 8080)
-
-```powershell
-# from the project root
-cd backend
-mvn clean install
-
-$env:DB_URL="<your-database-url>"
-$env:DB_USERNAME="<your-database-username>"
-$env:DB_PASSWORD="<your-database-password>"
-
-mvn spring-boot:run
-
-```
-
-- API base: <http://localhost:8080>
-
-### Start the frontend
-
-1. Start the frontend (port 3000)
-
-```powershell
-# from the project root (new terminal)
-cd frontend
-$env:DB_URL="<backend-url>" # optional:localhost:8080 is default
-pnpm install
-pnpm run dev
-```
-
-2. Open the app at <http://localhost:3000>
-
-## Auth
+## 🔐 Auth
 
 - Log in with `user1`..`user5` using the same value as the password (e.g., `user3`/`user3`).
 
-## Features
+## ✨ Features
 
 - Transformers and Inspections CRUD
 - Image uploads stored as base64 in the DB; baseline images can be added/removed
@@ -185,8 +22,11 @@ pnpm run dev
   - Adding Transformers: client-side check to ensure `transformerNumber` is unique
 - Cascade delete: deleting a Transformer removes its Inspections
 - AI model can be used to analyze thermal images of transformers (see `backend/AI/README.md` for details)
+- Persistance of AI annotated images
+- Users also may edit annotations or add their own annotations
+- Export of metadata and images as a ZIP file
 
-## Project structure (high level)
+## 🗂️ Project structure (high level)
 
 - `frontend/` — Next.js frontend
   - `app/` — App Router pages
@@ -196,32 +36,25 @@ pnpm run dev
   - `prisma/` — Prisma schema, migrations, and the SQLite DB file
   - `types/` — shared TypeScript types
 - `backend/` — Spring Boot app (controllers, entities, repos, config)
+  - `src/main/java/com/apexgrid/transformertracker/` — Java source code
+  - `src/main/resources/` — application config, including `application.yml`
+  - `AI/` — AI model and related files
 
-## Project Description
+## 📝 Project Description
 
 - The project has 2 main pages: transformers and inspections.
 - The transformers page allows users to create, read, update, and delete (CRUD) transformer records.
-![Screenshot of transformer page](transformer_page.png)
+  ![Screenshot of transformer page](transformers_page.png)
 - The inspections page allows users to view and manage inspection records.
-![Screenshot of inspections page](inspection_page.png)
+  ![Screenshot of inspections page](inspections_page.png)
 - Details pertaining to a particular transformer can be viewed in a user friendly interface.
-![Screenshot of transformer detail](transformer_detail.png)
+  ![Screenshot of inspection details page](inspection_details.png)
+- Details pertaining to a particular inspection can be viewed in a user friendly interface.
+  ![Screenshot of transformer detail](transformer_details.png)
 - An AI model can be used to analyze and generate insights from the thermal images of transformers.
-![Screenshot of AI inference page](ai_inference.png)
-
-## Troubleshooting
-
-- Windows PowerShell: to start with a custom backend URL temporarily, run
-
-  `$env:NEXT_PUBLIC_BACKEND_URL = "http://localhost:8080"; pnpm dev`
-
-  Or put the value in `.env.local` to make it persistent.
-
-- Backend port in use (8080): stop the process using the port, or temporarily change `server.port` in `backend/src/main/resources/application.yml`.
-- H2 console won’t connect: verify JDBC URL is `jdbc:h2:file:./db/transformerdb`, user `sa`, and empty password.
-- DB file not created: ensure the backend is running and you’ve performed at least one API action (the file appears on first write).
+  ![Screenshot of AI inference page](ai_inference.png)
 
-## For Improvements
+## 🛠️ For Improvements
 
 - Feel free to open issues or submit PRs for any bugs, improvements, or new features.
 - For your own use, you are free to customize the project as needed.