Ordinal Launchpad UI

This is a brief guide on how to use the package.json file and scripts in your project.

Getting Started

Firstly, ensure you have Node.js and Yarn installed on your computer. You can download Node.js from here and Yarn from here.

After installation, confirm that Node.js and Yarn were successfully installed by running the following commands in your terminal:

node -v
yarn -v

These should return the versions of Node.js and Yarn installed on your machine, respectively.

Installing Dependencies

Navigate to the root of the project where the package.json file is located. Install the necessary dependencies by running:

yarn

Running Storybook

This project uses Storybook for component development.

To start the Storybook development server, run the following command in your terminal:

yarn storybook

This will start the Storybook development server on port 6006. You can then view your Storybook by navigating to http://localhost:6006 in your web browser.

Building Storybook

If you want to create a static web app of your Storybook for distribution, you can use the build-storybook command:

yarn build-storybook

This will create a static web app in the storybook-static directory in your project folder.

Contributing

If you wish to contribute to this project, please ensure that any changes made are reflected in the Storybook components and are consistent with the overall project architecture.

More Information

For more information on the commands provided by this package.json file, or for any other questions, please refer to the Storybook documentation.

This repo is maintained by the Ordinals.Market team. Feel free to reach out in our Discord