CryptoAssist/README.md

19 lines
1.0 KiB
Markdown
Raw Normal View History

2017-08-17 10:38:38 +01:00
This is a webapp that allows data to be passed through various common simple ciphers. It was designed for use by students in cryptography competitions, and was my A Level Computer Science project.
# Demo
There is a public demo of the system available at https://cryptoassist.timstallard.me.uk
# Building it yourself
2017-03-13 11:15:57 +00:00
To build this project, you'll need to have Node.JS and NPM installed.
You can then download the project using Git, and install the dependencies:
1. `git clone https://github.com/TimStallard/CryptoAssist.git`
2. `npm install`
2017-03-14 09:46:37 +00:00
If you'd like to run webpack's development server, run `npm run dev-server`. This will start a web server listening on port 8080 with live reload and automatic recompilation when files are edited.
2017-03-13 11:15:57 +00:00
Babel isn't used for the development version, so you'll need to use a browser with full ES6 support.
To generate a minified ES5 version of the project for distribution, run `npm run build`. This will use Babel and Uglify to convert the project to ES5 and minify it. The output will be placed in the `build` directory.