mirror of
https://github.com/Keycapsss/awesome-mechanical-keyboard.git
synced 2024-11-30 19:36:24 +03:00
⌨️ A curated list of Open Source Mechanical Keyboard resources.
3d-printingawesomeawesome-listgridsome-websitehacktoberfestkeyboardkeyboard-layoutlistmechanical-keyboardmechanical-keyboardspcbqmkqmk-firmwarestarred-keycapsss-repostarred-repo
.github | ||
.vscode | ||
docs | ||
src | ||
static | ||
.gitignore | ||
.node-version | ||
.tailwind-hint.md | ||
gridsome.config.js | ||
gridsome.server.js | ||
package-lock.json | ||
package.json | ||
README.md | ||
runtime.txt | ||
tailwind.config.js |
Keebfolio
The goal of this repository is to collect mechanical keyboard related projects (preferably Open Source).
View the pages on Keebfolio.netlify.app or GitHub:
Contributing
Contributions are welcome!
To add content, edit the Markdown file in the docs folder and open a Pull Request. You can also open a new Issue.
Please use this commit message conventions.
The project uses Gridsome as a Static Site Generator.
Creating local development environment
Creating Github Auth Token
- Go to
https://github.com/settings/tokens
- Click "Generate new token"
- Set note and expiration, then click "Generate token"
- Copy generated token, you will need it in another step
Installation and running local version
- Create environment variables:
GITHUB_AUTH_TOKEN
with generated token as its value.GITHUB_API_V4_URL
with valuehttps://api.github.com/graphql
- Clone repository
npm install
npm run develop