Green-Software-Foundation / Green-Software-Foundation/if

Enable locally runnable visualiser

Open
#982 11 comments 0 reactions 3 assignees Claimed by @narekhovhannisyan View on GitHub
draft
Dominant language
TypeScript
Stars
183
Forks
51
PR merge metrics
No merged PRs in 30d

Description

**Why**: Sub of #951
**What**: enable visualising a manifest file locally without needing to upload it anywhere to get a URL

**Scope of work:**
- [ ] Discuss the potential solutions
- [ ] TBC

## Acceptance Criteria
### Scenario 1: Happy path
**GIVEN** user has IF set up on their localhost
**AND** user has a webserver and runnable if visualiser code
**AND** user has prepared a manifest file stored in `path A`
**WHEN** user calls `if-vis` with `path A` as parameter
**THEN** TBC

### Scenario 2: Refresh after changes
**GIVEN** user has IF set up on their localhost
**AND** user has a webserver and runnable if visualiser code
**AND** user has prepared a manifest file stored in `path A`
**AND** user has successfully run `if-vis` for the manifest file stored in `path A`
**AND** user has made changes to the manifest file stored in `path A`
**WHEN** user TBC - what is the trigger to get the web to update
**THEN**

### Scenario 3: Errors
**GIVEN** user has IF set up on their localhost
**WHEN** user calls `if-vis` in conditions described in table below
**THEN** user gets an error message that corresponds to the condition as described in the table below

| ID | Condition | Error message |
|-|-|-|
| 1 | Path param not provided | error message 1 |
| 2 | No file exists | error message 2 |
| 3 | Empty file | error message 3 |
| 4 | Manifest not parsable | error message 4 |

NOTES:
```
https://visualiser.if.greensoftware.foundation/?manifest=path/to/manifest.yaml

https://localhost:8080/?manifest=http://localhost:3000/manifest.yaml

if-vis manifest.yaml https://localhost:8080/
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.