Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.74 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.74 KB

bitcoinicons.com

This repo holds the soure code for bitcoinicons.com, the website for the Bitcoin icons project by the Bitcoin Design Community.

It's currently hosted under my Github profile, but should be moved to the Bitcoin Design Github organization once it's not so rough.

Contributions are highly appreciated. Design changes should first be discussed in design before implementing them. The source design for the site is in the Bitcoin icon set Figma community file on the "Website" page.

Updating icons

When icons change, two things need to be done for this repo.

  • Update src/data/icons.json
  • Update SVGs in public/svg

Both the JSON file and the SVGs are generated automatically via the export helper Figma plugin. The plugin creates a new page in the main Figma icon file with export-ready icons and the content of the JSON file in a text field.

Before committing, make sure to run the site locally first and double-check that everything looks good. It's easy to miss something.

Local development

It's possible to use just npm, I prefer using Vue UI, as it provides a visual interface for local development.

Make sure to use node 15.0.0+.

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.