masterzen / website

Entry point for the Mechanical Keyboards France community

claviers-mecaniques.fr

Requirements

• Node.js LTS
• a mechanical keyboard of your choice 👀

Build

npm install # install build dependencies
npm run build # build website

Serve

npm run serve

Note: With the serve command, two processes will run to serve the HTML files: one with hot reload, and a second to generate CSS for the SASS files. Modifying the code will reload the website but modifying the SASS files will not; you will have to refresh the page by yourself because there is no event spread between those two processes.

Contribute

Any contribution is welcome! Just run these commands before opening a pull request:

npm run prettier # Check code style
npm run prettier:fix # Fix code style
npm run chk:data # Ensure that data is well formated (e.g. keyboards)

Deploy

Travis automatically executes these tasks for every push on the master branch:

npm install
npm run chk:data
npm run prettier
npm run build

If no exception is thrown, Travis will push the output to the gh-pages branch.

---

Made in France 🇫🇷