Getting Started

Overview

Installation

Metal is currently a private npm repo. Reach out to the design-ops team for instructions on how to install.

Importing

After you install the Metal private repo, you can get started by importing the metal.css file into your project. Most Metal resources are included in this CSS file. You can find it in under node_modules/@foundry/metal/dist/css/metal.css. This file includes a set of design tokens and CSS class components.

Application Template

A great way to test if your CSS is correctly imported is by copying and pasting the below template!

This template is purely for testing purposes and includes Beta components. Learn about components.

Application Template

Efficiency

100%

Efficiency

70%

Efficiency

4%

Hashrate

336.7 PH/s

Miners

Miner Location Hashrate

123x123x12345

Miner 123

1234-123-1

999.12 KHs

123x123x12345

Miner 123

1234-123-1

999.12 KHs

123x123x12345

Miner 123

1234-123-1

999.12 KHs

		

		
	

Other Resources

Fonts can be found under node_modules/@foundry/metal/dist/fonts. If you are working on a Svelte project, you can find many Svelte components inside node_modules/@foundry/metal/dist/svelte, although these components are currently unsupported and undocumented. If you are interested, there are many Sass mixins that you may find useful in node_modules/@foundry/metal/dist/scss/_mixins.scss.