https://github.com/i-naeem/heyming
Heyming is a hamming code encoder and decoder built in React.js
https://github.com/i-naeem/heyming
chakra-ui hamming hamming-code hamming-code-simulator hamming-code-visualizer react reactjs
Last synced: about 1 month ago
JSON representation
Heyming is a hamming code encoder and decoder built in React.js
- Host: GitHub
- URL: https://github.com/i-naeem/heyming
- Owner: i-naeem
- License: mit
- Created: 2022-04-22T17:00:11.000Z (about 3 years ago)
- Default Branch: alpha
- Last Pushed: 2023-05-28T15:18:24.000Z (almost 2 years ago)
- Last Synced: 2023-05-28T16:23:43.494Z (almost 2 years ago)
- Topics: chakra-ui, hamming, hamming-code, hamming-code-simulator, hamming-code-visualizer, react, reactjs
- Language: JavaScript
- Homepage: https://i-naeem.github.io/heyming
- Size: 6.82 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Heyming
Heyming is a Hamming Code encoder and decoder which encodes given data in hamming code and decodes hamming code.
## About The Project
### Features
- Encodes data bits to hamming code.
- Decodes hamming code.
- Detect single bit errors in hamming code.
### Built With
- [React.js](https://reactjs.org/)
- [Chakra Ui](https://chakra-ui.com/)
- [Font Awesome](https://fontawesome.com/icons)
### 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 :fire:
```sh
git clone https://github.com/i-naeem/heyming.git
```
2. Install yarn packages :package:
```sh
yarn install
```
3. Start the development server. :hammer:
```sh
yarn start
```
4. Start the build. :sparkles:
```sh
yarn build
```
## Roadmap
- :heavy_check_mark: Add a README
- :heavy_check_mark: Add Decoder.
- :heavy_check_mark: Add dark mode.
- :heavy_check_mark: Add Meta Information.
- :black_large_square: 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](https://twitter.com/0x656e)
Project Link: [https://github.com/i-naeem/heyming](https://github.com/i-naeem/heyming)