⌨️ A curated list of Open Source Mechanical Keyboard resources.
Go to file
2023-11-29 09:58:38 +01:00
.devcontainer chore: adding devcontainer config (#155) 2023-11-29 09:58:38 +01:00
.vscode build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00
public build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00
src docs: add keyboard-tools, kicad-kbplacer and kle2netlist to tools 2023-11-28 20:46:12 +01:00
.gitignore build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00
.npmrc build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00
astro.config.mjs build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00
CODEOWNERS chore: adding CODEOWNERS 2023-11-28 20:53:19 +01:00
package-lock.json build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00
package.json build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00
README.md Fix a missing paren in README (#153) 2023-11-28 14:24:21 +01:00
sandbox.config.json build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00
tsconfig.json build: switch Gridsome to Astro 2022-10-24 15:24:07 +02:00

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 src/pages/en folder and open a Pull Request. You can also open a new Issue.
Please use this commit message conventions.

The project uses Astro as a Static Site Generator. Netlify Status

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
  4. npm run develop

License

CC4