Skip to content

Latest commit

 

History

History

mithril-explorer

Mithril Explorer

This is a work in progress 🛠️

A website showcasing data from a Mithril Aggregator made using Next.js.


Pre-requisites

Install node.js && (yarn)[https://yarnpkg.com/getting-started/install].

Getting Started

First, build the mithril-client-wasm package:

make -C ../mithril-client-wasm build

Then, run the development server:

make dev

Open http://localhost:3000 with your browser to see the result.

Enabling unstable features

Some features are still in development and are not enabled by default. To enable them, set the UNSTABLE environment variable to 1 when running the development server:

UNSTABLE=1 make dev

Or when building the production version:

UNSTABLE=1 make build

Adding or updating an icon of the 'Mithril' font

In the ./icons folder add or modify a svg.

If you add a new icon you need to reference and associate it with a codepoint in the ./fantasticonrc.js configuration file. The codepoint must be part of the unicode private use area, as such it must be an integer between 57344 and 63743 (hex: E000-F8FF).

Then rebuild the font:

make icons-font

You can then use the icon in the js, ie if your icon name is shield:

<i className={`bi mi mi-shield`}></i>