wouterfennis / cifra Goto Github PK

At the moment there is only a console application to use Cifra at the moment.
This isn't the most easy way to input data and quickly edit previous inserted data.
That's why it is a good idea to create a seperate project to create the Classes and Tests data.

This project has to conform the following criteria

• It has to run locally on any computer (Windows, OSX)
• It has to run offline
• It should produce Class and Test files
• It should be able to read existing Class and Test files to edit them

Example of Class JSON structure:

[
  {
    "Id": "86d4ea7e-2fb1-4d58-8ec4-7143c4ce4b68",
    "Name": "ClassName",
    "Students": [
      {
        "FirstName": "FirstName",
        "Infix": "infix",
        "LastName": "LastName"
      }
    ]
  }
]

Example of Test JSON structure:

[
  {
    "Id": "a4bb745a-151a-4b74-acaa-0bd01f95d8ea",
    "Name": "TestName",
    "Assignments": [
      {
        "Id": "bc1c4357-3a4f-4fac-8817-4fe1aed23b2a",
        "Questions": [
          {
            "MaximumScore": 2,
            "QuestionNames": [
              "QuestionName"
            ]
          },
          {
            "MaximumScore": 1,
            "QuestionNames": [
              "QuestionName1",
              "QuestionName2"
            ]
          }
        ]
      },
      {
        "Id": "a4491d78-f7b7-4185-a7ce-bcb39425039f",
        "Questions": [
          {
            "MaximumScore": 2,
            "QuestionNames": [
              "Question3"
            ]
          }
        ]
      }
    ],
    "MinimumGrade": 5,
    "StandardizationFactor": 2
  }
]

Cifra assumes during startup that certain files/folders are present and correctly configured.
By creating an auto installer step during startup this can be automated for the users and reduced the manual install time needed to get started

Only the .json file seems to be uploaded. Fix the build so that the .exe artifact is also included

To keep the projects separate maintainable and usable in other projects the WorksheetWriter abstraction library must be placed in a separate repository.

After the migration a Nuget Pipeline can be configured so that the Cifra application can include it and keep working

Improve documentation by write a usefull README.md

#14

To perhaps use it in an PWA later on..
Is this possible?
How difficult would it be?
Can it be used as a library in a PWA?

A integration test from start to finish.

Create a class
Create a test
Create a spreadsheet with test results

Assert the above

The styling of the current console app is just basic. To make it more attractive and easy to use the styling could be improved.
Better use of the space, more with coloring,
More graphic overview of data for example

Currently its only possible to publish the project with the right settings in Github or in Visual studio.
Create powershell and batch scripts in order to publish it locally without much dependencies

When you currently save a spreadsheets that already exists on disk the program will fail.
We need more defensive programming to prevent this.
The https://github.com/wouterfennis/SpreadsheetWriter needs to be more robust and give a clear message if the saving went successful or that an error did occur.
Cifra will have to handle the situation where a file can't be saved.
Maybe ask for an other name or try again.