# Project plan — sawis_reporting

Evidence date: 2026-10-04.

Source repository: `git@bitbucket.org:overdrive/sawis_reporting.git` (cloned for this inspection as `https://bitbucket.org/overdrive/sawis_reporting.git`).

The scan-host path `~/projects/sonar_scan/repos/sawis_reporting` was not on this machine. The tree below was read from `master` at `520145d` (2020-10-12). This plan describes what the repository contains. It does not decide what the product should become.

## Product

There is no README, license file, or product requirements document in the repository or in Silicon Ark before this set.

The only application statement is `index.php`, which prints the string `hello world`. Beside it, `index.html` is the Material Design Lite 1.3.0 dashboard sample: title "Material Design Lite", description "A front-end template that helps you build fast, modern mobile web apps.", placeholder account `hello@example.com`, and a "View Source" link to Google's dashboard template.

The repository name is `sawis_reporting`. The content commit is by Selwin Matthyse `<selwin@sawis.co.za>`. No file in the tree contains the word SAWIS, a wine-industry term, a report query, or a data source. Silicon Ark's `sawis_staging` documents do not mention this repository, and this repository does not mention `sawis_staging`.

**Unknown / Requires Confirmation:** the product purpose, the audience, and whether the name means a SAWIS reporting product that was never built.

## Branch reality

| Line | Tip | Date | What it is |
|---|---|---|---|
| `master` (default; `origin/HEAD`) | `520145d` | 2020-10-12 12:00:11 +0200 | Selwin Matthyse, message "first commit". Adds the dashboard files and `index.php`. Parent is `db8c5ca`. |
| parent of `master` | `db8c5ca` | 2020-10-12 09:10:21 +0000 | Jaco Brits `<jaco@overdrive.co.za>`, message "Initial commit". Adds Bitbucket's example `.gitignore` only. |

No other branches and no tags were present. History does not show a later release, a removed feature, or a second product iteration.

**Discrepancy:** the task-creation scan listed `sonar-project.properties` and `sonarqube_scan.bat` at the repository root. Neither file is in git at `520145d`. Provenance: **Unknown** — they may have been untracked files on the scan host. Their contents were not available to read.

## Objectives (inferred from the implementation, not from a written plan)

- Serve a browser dashboard styled with Material Design Lite.
- Serve a PHP response that prints `hello world`.

Nothing in the tree states a reporting objective. Treating "reporting" as a goal is an inference from the repository name only.

## Scope

### In scope of `master`

1. `index.html` — Google's MDL dashboard template, with asset URLs that do not match the files in git.
2. `index.php` — one `echo`.
3. `assets/js/styles.css` — the template stylesheet (Apache 2.0 header, Google, 2015).
4. `assets/images/` — five images used by that template: `android-desktop.png`, `dog.png`, `favicon.png`, `ios-desktop.png`, `user.jpg`.
5. `.gitignore` — Bitbucket's commented example ignore list from the initial commit.

### Out of scope (not present)

- Report definitions, filters, exports, schedules, or datasets.
- Authentication, users, roles, or sessions.
- A database, API, queue, worker, or storage integration.
- Tests, a dependency manifest, a container, a pipeline, or a deploy script.
- A project README or a project `LICENSE` file. The Apache 2.0 text in `index.html` and `styles.css` is the template header, not a repository license chosen in a later commit.

## System architecture

Two independent root files. Nothing links them.

```text
index.html  →  CDN: Roboto, Material Icons, MDL 1.3.0 CSS and JS
            →  local URLs styles.css and images/*   (those paths are not in git)

index.php   →  prints hello world
            →  does not include index.html

assets/js/styles.css and assets/images/*  →  present, not referenced by the HTML URLs
```

There is no application server code, router, or build step.

## Major components

| Component | Role on `master` | Provenance |
|---|---|---|
| Dashboard page | Static HTML shell with fixed charts, menus, and cards | Implemented. Copy is the MDL sample |
| Template CSS | Dashboard layout rules, including a dog image on the Updates card | Implemented. Not loaded by the HTML as written |
| Template images | Homescreen icons, favicon, avatar, card illustration | Implemented. HTML points at `images/`, not `assets/images/` |
| PHP script | Prints `hello world` | Implemented |
| Git ignore template | Example patterns; comment says to customize it | Implemented. Not customized |

## Milestones

| When | Evidence | Status |
|---|---|---|
| 2020-10-12 | Repository created with a default `.gitignore` | Completed |
| 2020-10-12 | Dashboard template and `index.php` committed | Completed |
| After 2020-10-12 | No further commits on `master` | No later milestone is in git |

## Implementation plan

No implementation plan is written in the repository. The committed result is the template plus the PHP line. Asset paths were not updated to `assets/`.

## Known dependencies

Runtime dependencies are URLs in `index.html`, not pinned packages:

| Dependency | Where | Notes |
|---|---|---|
| Material Design Lite 1.3.0 CSS and JS | `https://code.getmdl.io/1.3.0/` | Loaded in the browser. Not vendored |
| Roboto and Material Icons | `https://fonts.googleapis.com` | Loaded in the browser |
| PHP | `index.php` uses `<?php` | No version constraint in the repo |
| A web server | Not configured in the repo | Which file is the directory index is **Unknown** |

`material.min.js` is required for the MDL drawer, menus, and expandable search field to upgrade. The page has no other script.

## Current project status

**Dormant scaffold.** Last commit 2020-10-12. The dashboard cannot show its own stylesheet or images with the URLs in `index.html`. The PHP file does not render that dashboard. No reporting behaviour is implemented.

**Unknown / Requires Confirmation:**

- Whether anyone still deploys this repository.
- Whether `index.php` or `index.html` is what a browser receives.
- Whether the scan-host Sonar files belong in git.
- The intended relationship, if any, to other SAWIS systems.