Socket
Socket
Sign inDemoInstall

mainstack-design-system

Package Overview
Dependencies
24
Maintainers
0
Versions
58
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

mainstack-design-system

<!-- @format -->


Version published
Weekly downloads
304
Maintainers
0
Created
Weekly downloads
 

Readme

Source

Storybook Documentation

To view the design system documentation, visit this link.

Usage

Install the design system

yarn add mainstack-design-system

Add the Design system provider to your root file

import { MainstackProvider } from "mainstack-design-system";

 <MainstackProvider>
  <App/>
</MainstackProvider>

Components

Components can be used by importing from the 'mainstack-design-system directory. For example:

import { Button } from 'mainstack-design-system';

Icons

Icons are imported from the 'mainstack-design-system directory. For example:

import { ArrowRightIcon } from 'mainstack-design-system';

Colors

Colors are imported from the mainstack-design-system directory. For example:

 import {Colors} from "mainstack-design-system";

 <Text color={Colors.black300}>Hello World</Text>

Contributing

Installing the application (as a developer) is simple in the following steps:

  • Access and Clone this repository
git clone git clone https://github.com/The-Mainstack/mainstack-design-system.git && cd [repo-name]
  • Make your forked repo the remote upstream (at origin)
git remote add origin https://github.com/The-Mainstack/mainstack-design-system.git
  • Navigate into the cloned directory and install dependencies with Yarn
yarn add
  • Make a duplicate of the env file and update its content accordingly. Most times, this is just fine with no update.
cp .env.sample .env
yarn dev

To run storybook, run the following command:

yarn storybook

To Publish to NPM, run the following command:

 npm publish --access public

Edit doc on Joggr

FAQs

Last updated on 13 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc