Skip to content

review/review.github.io

Repository files navigation

Review

Example of using review:

https://review.github.io/?log=gh:review/review.github.io/master/examples/simple-sphere.json

Link to all examples found in the examples directory:

Review Log-File Schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Review Log-File",
    "description": "A visualization of meshes evolving through time.",
    "type": "object",
    "properties": {
        "name": {
            "description": "A unique name for this animation.",
            "type": "string"
        },
        "timeStep": {
            "description": "Time elapsing between frames.",
            "type": "number",
            "exclusiveMinimum": 0
        },
        "objects": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "name": {
                        "description": "A unique identifier for a single object.",
                        "type": "string"
                    },
                    "mesh": {
                        "description": "Specify the object mesh (primitives only for now).",
                        "type": "string",
                        "enum": ["cube", "cylinder", "sphere"]
                    }
                },
                "required": ["name", "mesh"]
            },
            "minItems": 1
        },
        "frames": {
            "type": "array",
            "items": {
                "type": "object",
            },
            "minItems": 1
        }
    },
    "required": ["name", "timeStep", "objects", "frames"]
}

Development

# Installation: prerequisite: Node+npm
npm install -g parcel-bundler

# Development
cd elm
parcel index.html

# Building for production
cd elm
rm -r dist 
git rm ../*.js ../*.map
parcel build index.html
mv dist/* ../
git add ../*.js ../*.map
git commit -am "New build."
git push -u origin master

Tasks