kbsim - GitLite

KO | EN

gitlite — search

#javascript #typescript #golang #rust #deep-learning #docker #java #windows #cli #vue #security #mcp #ios #openai

kbsim

(★ 243)

Mechanical keyboard simulator website w/ a typing test. Offers 10+ unique switch sounds, layouts, and keyboard colors for an oddly satisfying typing experience.

File Explorer

Download Latest Version (.zip)

- - robots.txt
- App.test.js
- index.css
- index.html
- index.js
- serviceWorker.js
.babelrc
.gitignore
LICENSE.md
package.json
README.md
webpack.config.js
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/tplai/kbsim

Downloads the entire project code from GitHub to your computer.

cd kbsim

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

├── package.lock.json # npm dependency lockfile

Type this command into your terminal and run it.

└── yarn.lock # yarn dependency lockfile

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mechanical Keyboard Simulator - [kbs.im](https://kbs.im)
![kbs.im picture](https://github.com/tplai/kbsim/blob/master/src/assets/images/demo.PNG)

Mechanical Keyboard Simulator is website that simulates typing on a variety of custom keyswitches and offers a simple typing test. Currently, it supports 10+ switches, keyboard layouts, and colors for an customizable, satisfying typing experience.

## Features
- Unique sounds for specific keys
- 1 minute English typing test
- Wide selection of case colors and layouts
- Dark mode

## Currently Supported Switches
- NovelKeys Creams
- Holy Pandas
- Turqoise Tealios
- Gateron Black Inks
- Cherry MX Blacks
- Cherry MX Browns
- Cherry MX Blues
- Kailh Box Navies
- Buckling Spring
- SKCM Blue Alps
- Topre

## Currently Supported Layouts
- Fullsize
- Tenkeyless
- 75%
- 65%
- HHKB

## Requests
Switch and layout requests are open at the moment, feel free to open an issue if you'd like to see a switch or layout added!

# Developers

## Setup
To run this application locally, use:

```bash
npm install
npm start
```

## Project structure
    .
    ├── src                                           # Source files
    │   ├── assets                                    # audio and image assets
    |   |   ├── audio  
    |   |   └── images
    │   ├── features                                  # components and modules
    │   |   ├── Store                                 # Redux store
    |   |   |   └── store.js
    |   |   └── sampleComponent                       # component structure
    |   |       ├── SampleComponent.js
    |   |       ├── SampleComponentSlice.js
    |   |       └── SampleComponent.module.css
    │   ├── public                                    # robots.txt
    |   |   └── robots.txt
    |   ├── App.test.js                               # starter React test file
    |   ├── index.css                                 # index styling
    |   ├── index.html                                # meta tags
    |   ├── index.js                                  # React entry point
    |   └── serviceWorker.js                          # basic offline usage serviceWorker
    ├── .babelrc                                      # babel transpiler config
    ├── LICENSE.md                                    # MIT license
    ├── README.md                                     # you're reading this!
    ├── package.lock.json                             # npm dependency lockfile
    ├── package.json                                  # dependency file
    ├── webpack.config.json                           # webpack config file
    └── yarn.lock                                     # yarn dependency lockfile

## Contributing
Pull requests are welcome, but please do create an issue to discuss any major changes.