slvoog / keycodes

Easy visualizer for JavaScript KeyCodes

JavaScript Keycodes → KeyCode.info

Keycodes is a simple website which allows users to press any key and instantly get the JavaScript Key or Key Code KeyboardEvent. Check out the Tool and Event List. It is build with Next.js and Typescript.

Development

You'll need node and yarn installed on your machine.

• Install dependencies yarn
• Run the development server: yarn dev
• Open http://localhost:3000 in your browser

You can also start project with docker - docker-compose up

Development mode

There is a docker-compose.yml which runs the app

docker-compose up

Open http://localhost:3000 with your browser to see the result.

See also

• Testing
• Linting
• Logging

Contributing

First off, thanks for taking the time to contribute! We welcome feedback in all forms, issues, comments, PRs, etc. and we always want to hear what the keycodes community thinks!

Contributing Guide

There are many ways in which you can participate in this project, for example:

• Submit bugs, feature requests, and ideas, and help us verify as they are checked in
• Review source code changes
• Review the documentation for any typos and improvements

If you are interested in fixing issues and contributing directly to the code base, please see the How to Contribute document which covers the following:

• Submitting pull requests
• Coding guidelines
• How to find issues to work on
• How to use the labels

Providing Feedback

• Request a new feature
• Upvote popular features requests
• Create an issue

Code of Conduct

This project has adopted the Contributor Covenant Code of Conduct

Contributor License Agreement

Licensed under the MIT license.