Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/genesy/karabiner-complex-rules-generator
Simple web app to help generate Karabiner Elements Complex Rules
https://github.com/genesy/karabiner-complex-rules-generator
Last synced: about 2 months ago
JSON representation
Simple web app to help generate Karabiner Elements Complex Rules
- Host: GitHub
- URL: https://github.com/genesy/karabiner-complex-rules-generator
- Owner: genesy
- License: gpl-3.0
- Created: 2020-02-23T18:06:26.000Z (over 4 years ago)
- Default Branch: source
- Last Pushed: 2023-01-05T08:05:51.000Z (over 1 year ago)
- Last Synced: 2024-04-21T07:34:40.126Z (5 months ago)
- Language: TypeScript
- Size: 3.54 MB
- Stars: 488
- Watchers: 6
- Forks: 24
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
Karabiner Complex Rules Generator
View Demo
·
Report Bug
·
Request Feature
·
Send a Pull Request
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
## About The Project
An open-source web app to help make and configure karabiner complex modification files!
### Built With
- ReactJS
- Material UI
## Getting Started
### Prerequisites
- yarn
```sh
npm install yarn -g
```
### Installation
1. Clone the project
```sh
git clone https://github.com/genesy/karabiner-complex-rules-generator.git
```
2. Install NPM packages
```sh
yarn install
```
## Roadmap
See the [open issues](https://github.com/genesy/karabiner-complex-rules-generator/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **extremely appreciated**.
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 GNUv3 License. See `LICENSE` for more information.
## Contact
Gene Sy - [@GeneSy](https://twitter.com/GeneSy) - [email protected]
Project Link: [https://github.com/genesy/karabiner-complex-rules-generator/](https://github.com/genesy/karabiner-complex-rules-generator/)
## Acknowledgements
- [Img Shields](https://shields.io)
- [GitHub Pages](https://pages.github.com)
- [Karabiner Elements](https://pqrs.org/osx/karabiner/)
[forks-shield]: https://img.shields.io/github/forks/genesy/karabiner-complex-rules-generator?style=for-the-badge
[forks-url]: https://github.com/genesy/karabiner-complex-rules-generator/network/members
[stars-shield]: https://img.shields.io/github/stars/genesy/karabiner-complex-rules-generator?style=for-the-badge
[stars-url]: https://github.com/genesy/karabiner-complex-rules-generator/stargazers
[issues-shield]: https://img.shields.io/github/issues/genesy/karabiner-complex-rules-generator?style=for-the-badge
[issues-url]: https://github.com/genesy/karabiner-complex-rules-generator/issues
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/roshan-lamichhane