Skip to content

Latest commit

 

History

History
120 lines (82 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

120 lines (82 loc) · 2.93 KB

Contributing

Any contribution is welcome.

To avoid reliance on third party services, this project will require community support to extend and maintain the list of tracked asset backings.

For the most part this only requires adding or updating data files.

How do I get set up?

Install nvm

For the package management, we need to install Node. To install a specific version of Node, we will first install the Node Version Management (nvm).

Download and install nvm:

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

Reload the .bashrc:

source ~/.bashrc

Install Node

You should now be able to list all available Node versions like this (--lts for versions with long term support):

nvm list-remote --lts

You can find some information about the major versions and their long term support on the release page of Node.js.

You can install the latest v20 version with long term support with this command:

nvm install v20 --lts

Switch to the project folder and install the dependencies.

cd portal
npm install

How to locally run the adapters?

To see if everything is working you can run the adapters like that.

npm run dev

How do I run tests?

Execute:

npm test

Icons

General considerations

  • Original image is stored in SVG format
  • Original image must have a minimum resolution of 256
  • If the original is only available as PNG or JPEG, either embed the SVG or trace the image.

Rules for SVGs

  • Square view box
  • Optional: Normalized view box of 256x256
  • All text should be presented as outlines
  • File name icon.svg
  • File size <=30kb
  • Transparent background
  • Prettified markup (not minified)
  • Remove any unnecessary content like doctype, XML instructions, comments, editor data
  • Include xmlns for HTML embedding

How to resize view box?

  1. Open SVG in Inkscape.
  2. Select all objects in the SVG (STRG + A).
  3. Navigate to "Object" -> "Transform" -> "Scale"
  4. Select "px"
  5. Select "Scale propertionally"
  6. Enter 256 for width and height
  7. Press apply
  8. Open "File" -> "Document Properties"
  9. Adjust "Custom size" width and height to 256 and close window
  10. "File" -> Save a Copy

How to prettify SVG?

To simplify the SVG, use the VS Code jock.svg extension command "Minify SVG" to minify the SVG as configured in the projects settings. Afterwards format with prettier.

Helpful resources

Crypo related

General SVG icons