Git Product home page Git Product logo

enigma-emulator's Introduction

enigma-emulator

contributions welcome License: MIT

Enigma machine emulator (https://enigma.lh.mk) for the Web. The emulator is faithful to the workings of the Enigma I, M3 and M4.

I highly recommend checking out the Enigma Operator's Field Manual before using the emulator.

Enigma

Starting the emulator

Cloning the repository

git clone https://github.com/lubeskih/enigma-emulator.git && cd enigma-emulator

Installing required packages

yarn install

Running the emulator

yarn start

Navigating around the repository

  • src - Main source directory
  • src/components - React components
  • src/constants - Constant variables used around the project (e.g. Enigma wiring, turnovers etc...)
  • src/enigma-logic - Files that hold the main logic behind the Enigma (stepping, turnover etc..) behind the rotors, reflectors, stators etc...
  • src/misc - Misc
  • src/store - MobX store files
  • src/types - Interfaces/Types used in the project

Contributing

Although I consider this project finished, contributions are more than welcome.

If you want to contribute, start with opening an issue before writing the code so we can first discuss the idea.

If everything goes well, you are free to open a PR, but please don't forget to include details about your changes.

Reporting an issue

If you want to report an issue, please use GitHub's issue system.

Contact

Drop me a line or two at [email protected], phone would be easier if you have my number.

License

This Enigma machine emulator is MIT licensed.

enigma-emulator's People

Contributors

dependabot[bot] avatar lubeskih avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.