This is my personal fork of Knekt and includes some changes compared to the official Knekt repository.

Knekt

Knekt is an interactive web application intended to be used as an aid for teaching classical encryption methods and their weaknesses.

Why is the application called Knekt?

Because Knekt is a pun on the Swedish word "knäckt", which translates into cracked. This so happens to be exactly what the encrypted texts should be after having faced this application coupled with your excellent decryption skills.

Directory structure

app/

The app/ directory is where you'll find the development code. Subdirectories are:

• css - For all CSS and SASS files.
• img - For images such as logotypes and favicons.
• js - For all project specific JS source code files.
• lib - For external JS libraries.
• res - Currently used to store the encrypted text files.
• test - Unit test files.

dist/

The dist/ directory holds deployment ready code. Use this in production. The content of dist/ is similar to app/ with the following differences per subdirectory:

• css - SASS specific files (*.scss and *.css.map) are not included.
• js - Has a single file, knekt.min.js, which is an optimized and minified version of all the files in app/js.
• lib - All files are the minified counterparts to the files in app/lib.

docs/

This directory holds auto-generated documentation from the JSDoc comments in the JavaScript source code. To read it, open docs/index.html in any browser.

Code style guidelines

Our ambition is to follow Google's style guides for HTML/CSS and JavaScript, with the exception that we use 4 space indentation for JavaScript.

Libraries and dependencies

Knekt uses the following JavaScript libraries:

• jQuery
• Highcharts
• Handlebars
• Dragula
• Hashcode
• Konami-JS

For unit testing we've used Karma and QUnit.

Building the application

Our build system minimizes/optimizes the JavaScript code and updates the index.html file. The build system requires Closure Compiler and HTML Tidy. To generate a new build in the dist/ directory, run make. See the Makefile for further details.

Contributors 🐸

• Fredrik Bergstrand
• Kimberley French
• Rebecka Geijer Michaeli
• Eric Henziger
• Oscar Johansson
• Robert Kumpulainen
• Erik Rönmark
• Kristoffer Tennivaara
• Victor Tranell

We want you to become a cryptoad contributor as well. Have a look at CONTRIBUTING.md for instructions on how to proceed.

License

Knekt is licensed under the MIT license. However, Knekt is distributed with non-free components that permits non-commercial use. Remove Highcharts if you wish to use this software for commercial purposes.

See LICENSE for further details.