https://github.com/Keycapsss/awesome-mechanical-keyboard

⌨️ A curated list of Open Source Mechanical Keyboard resources.
https://github.com/Keycapsss/awesome-mechanical-keyboard

List: awesome-mechanical-keyboard

3d-printing awesome awesome-list gridsome-website hacktoberfest keyboard keyboard-layout list mechanical-keyboard mechanical-keyboards pcb qmk qmk-firmware

Last synced: about 2 months ago
JSON representation

⌨️ A curated list of Open Source Mechanical Keyboard resources.

• Host: GitHub
• URL: https://github.com/Keycapsss/awesome-mechanical-keyboard
• Owner: Keycapsss
• Created: 2018-06-15T14:15:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-26T21:02:23.000Z (8 months ago)
• Last Synced: 2024-05-19T17:25:02.147Z (7 months ago)
• Topics: 3d-printing, awesome, awesome-list, gridsome-website, hacktoberfest, keyboard, keyboard-layout, list, mechanical-keyboard, mechanical-keyboards, pcb, qmk, qmk-firmware
• Language: Astro
• Homepage: https://keebfolio.netlify.app/
• Size: 1.33 MB
• Stars: 2,809
• Watchers: 85
• Forks: 185
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• starred - Keycapsss/awesome-mechanical-keyboard - ⌨️ A curated list of Open Source Mechanical Keyboard resources. (Astro)
• awesome-repositories - Keycapsss/awesome-mechanical-keyboard - ⌨️ A curated list of Open Source Mechanical Keyboard resources. (Astro)
• jimsghstars - Keycapsss/awesome-mechanical-keyboard - ⌨️ A curated list of Open Source Mechanical Keyboard resources. (Astro)

README

        

# Keebfolio

The goal of this repository is to collect mechanical keyboard related projects (preferably Open Source).

View the pages on [Keebfolio.netlify.app](https://keebfolio.netlify.app/) or GitHub:

- [Staggered](src/pages/en/staggered.md)

- [Ortho](src/pages/en/ortholinear.md)

- [Split](src/pages/en/split.md)

- [Other](src/pages/en/other.md)

- [Firmware](src/pages/en/firmware.md)

- [Miscellaneous](src/pages/en/miscellaneous.md)

- [Tools](src/pages/en/tools.md)

- [Tutorials](src/pages/en/tutorials.md)

## Contributing

Contributions are welcome!  

To add content, edit the Markdown file in the [src/pages/en](src/pages/en/) folder and open a [Pull Request](https://help.github.com/en/articles/about-pull-requests). You can also open a new [Issue](https://github.com/Keycapsss/awesome-mechanical-keyboard/issues).  

Please use this [commit message conventions](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13).

The project uses [Astro](https://astro.build) as a Static Site Generator.

[![Netlify Status](https://api.netlify.com/api/v1/badges/06821f1d-3e33-4bd4-92b2-4e44f3583060/deploy-status)](https://app.netlify.com/sites/keebfolio/deploys)

#### Creating local development environment

##### Creating Github Auth Token

1. ~~Go to `https://github.com/settings/tokens`~~

2. ~~Click "Generate new token"~~

3. ~~Set note and expiration, then click "Generate token"~~

4. ~~Copy generated token, you will need it in another step~~

##### Installation and running local version

1. ~~Create environment variables:~~

   - ~~`GITHUB_AUTH_TOKEN` with generated token as its value.~~

   - ~~`GITHUB_API_V4_URL` with value `https://api.github.com/graphql`~~

2. ~~Clone repository~~

3. ~~`npm install`~~

5. ~~`npm run develop`~~

### License

[![CC4](https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-sa.svg)](http://creativecommons.org/licenses/by-nc-sa/4.0/)