osoc20 / artiffact-control Goto Github PK

View Code? Open in Web Editor NEW

3.0 2.0 4.0 8.52 MB

A desktop application in which you can validate TIFF image files with information about cultural heritage collections.

Home Page: https://osoc20.github.io/ArTIFFact-Control/

License: MIT License

JavaScript 2.81% TypeScript 90.55% CSS 6.64%

quality-control tiff-files digitization heritage

artiffact-control's Issues

Create an about page

Create a barebones about page

Create slides for the pitch

Create (max 6) slides for the hackaton pitch

User Testing preparation

making a document with questions and tasks for the user testing.

Business Deliverables

Final pitch video, 1 minute, (with presentation)
Invitations sent to interested parties

Can't build the app

Design the statistics page

The page that shows the statistics should be designed.
figma file

Create a dashboard

Create a barebones dashboard.

Design a mockup for presentations

Create a mockup of the application where the application design is shown on a computer screen.
figma file

Design periodical check page

Design the page that allows users to periodically check files.
figma file

Design reports page

Design the page that shows all reports that were generated.

figma file

Create a page for the periodical checks

Create a barebones page for the periodical checks.

Design the result page

Design the result of the file check page.
figma file

Slides client meetup

Design slides in Figma and prepare a walkthrough of the first new GUI design.

Contacting users for user testing

Changes first usertest

We need to make some changes after the usertest:

XML blured out
Files checked -> check a file
Giving a name
Always show: choose a destination
checkboxes should have a check in them as well

Two reports are generated when checking files

This function is called in the render procedure. This causes it to update multiple times

ArTIFFact-Control/src/renderer/components/FileUploadStages/ProcessFiles/Stage3.tsx

Lines 211 to 231 in fd01558

    
           const renderResults = () => { 
        
               let reports: ReportParent = {reports: [], formats: null}; 
        
               responseObjects.forEach((response: JhoveValidationResponse) => { 
        
                   let report: Report = { 
        
                       date: new Date(), 
        
                       fileName: response.fileName, 
        
                       errors: getMessageCount(response, ERROR), 
        
                       passed: response.valid, 
        
                       result: response.wellFormed === 1, 
        
                       score: 100, 
        
                       warnings: getMessageCount(response, WARNING), 
        
                       infos: getMessageCount(response, INFO), 
        
                       filePath: files[responseObjects.indexOf(response)].path, 
        
                   } 
        
                   reports.reports.push(report); 
        
               }); 
        
               return <> 
        
                   <ReportDetails reportParent={reports} /> 
        
               </> 
        
           }

A possible solution to this is using a React useEffect hook that handles the creation of the reports. This hook only needs to run when file processing has been completed.

Pitch preperation 15/07

Project description
What you've built
What you've learnt

Make it possible to store/read configurations from disk

Style the add configuration flow

Is blocked by #61. This issue needs to be finished first

Create a page for the conformance checks

Create a barebones page for conformance checks

Inspect and break down DPF manager

gather information about all the elements and structure of the UI of dpf manager

Add a functional sidebar to the application

The sidebar should have buttons that redirect to

Create a README that explains the project

Think of what that should be in the readme and what not

Design an about page

Design an about page with some general information about the application.
figma file

Create the configuration creation flow

Create the flow that enables users to create a new configuration. This configuration needs to be stored on disk as well. (see #60)

Styling the flow is not inside scope of this issue.

Final user test and feedback design changes

Save and read reports from disk

Related to #60

Design conformance checks page

A page where files can be conformance checked should be designed.
figma file

Create process for making new configuration

Setup CI/CD

Some CI/CD would be nice but doesn't have high priority

Use of custom icons/fonts

Create a place to store global style elements

Right now, a lot of style elements are copied over to different files.
For example StyledTableRow is declared both in LastConfigurations.tsx and LastPeriodicalChecks.tsx.

It would be better if components like this are put in a global style folder or something.

Create a page for the reports

Create a barebones page for all reports that have been made.

Create the file checks page (stage 1)

Create a barebones file check page. This only involves the first stage of checking files (the uploading part)

Record the pitch

Recording the pitch for the first week 3day

Ask feedback in design channel

Share the current state of the design with others to get feedback. Be proud!!

design information and warning dialogs

Create a complete styleguide

A complete styleguide should be created based on the already created mockup

figma file

Feedback Design

Ask design feedback in the design channel in discord

Proposal to do it next week (20 - 23 )

Final Handover

Setup Github Project Page with general information
Handover document
Send mail to partner with full handover

Create the file checks page (stage 2)

Create a barebones stage 2 page for the file checks. (configuration picker)

Contact Miet for user testing tips

Design the help page

A help page should be designed that displays some basic information about the application.
figma file

Create the file checks page (stage 3)

Create a barebones stage 3 page for the file checks (check result)

Communication & Design Deliverables

All assets gathered in in the google drive, in your folder
Research, pictures, customer journey
Style guide or style tiles
Wireframes, sketches, mockups, animations gathered
Communication plan, articles
User testresults
User documentation
List of clearly stated issues, bugs & todos
Future recommendations

Technical Deliverables

Link to demo, MVP, prototype or product
Complete code on Github merged to master
Understandable & complete README
List of clearly stated issues, bugs & todos

	const renderResults = () => {
	let reports: ReportParent = {reports: [], formats: null};
	responseObjects.forEach((response: JhoveValidationResponse) => {
	let report: Report = {
	date: new Date(),
	fileName: response.fileName,
	errors: getMessageCount(response, ERROR),
	passed: response.valid,
	result: response.wellFormed === 1,
	score: 100,
	warnings: getMessageCount(response, WARNING),
	infos: getMessageCount(response, INFO),
	filePath: files[responseObjects.indexOf(response)].path,
	}
	reports.reports.push(report);
	});

	return <>
	<ReportDetails reportParent={reports} />
	</>
	}

osoc20 / artiffact-control Goto Github PK

artiffact-control's People

Contributors

Stargazers

Watchers

Forkers

artiffact-control's Issues

Recommend Projects

Recommend Topics

Recommend Org