Heyming

Heyming is a Hamming Code encoder and decoder which encodes given data in hamming code and decodes hamming code.

View Demo · Report Bug · Request Feature

About The Project

Features

• Encodes data bits to hamming code.
• Decodes hamming code.
• Detect single bit errors in hamming code.

Built With

• React.js
• Chakra Ui
• Font Awesome

What I Learned ?

• Chakra Ui
• React Custom Hooks
• How Hamming Code Works

Getting Started

To run this project you would require Node v17 or above and yarn installed on your computer.

Installation

1. Clone the repo 🔥

   git clone https://github.com/i-naeem/heyming.git

2. Install yarn packages 📦

   yarn install

3. Start the development server. 🔨

   yarn start

4. Start the build. ✨

   yarn build

Roadmap

• ✔️ Add a README
• ✔️ Add Decoder.
• ✔️ Add dark mode.
• ✔️ Add Meta Information.
• ⬛ Add left to right or right to left for decoder.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Mohammad Naeem - @nemoxhan

Project Link: https://github.com/i-naeem/heyming