@rfdez/design-system

Rfdez's Design System

My personal design system.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License

About The Project

My personal design system.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• node
• yarn

Installation

• Clone the repo

  git clone https://github.com/rfdez/design-system.git
  

• Install packages

  yarn install
  

• Run the project in development mode

  yarn dev
  

(back to top)

Usage

This project is a design system, so you can use it as a reference to build your own design system. You can also use it as a boilerplate to start your own project. The project uses Storybook to show the components and their documentation.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

• Fork the Project
• Create your Feature Branch (git checkout -b feature/AmazingFeature)
• Commit your Changes (git commit -m 'Add some AmazingFeature')
• Push to the Branch (git push origin feature/AmazingFeature)
• Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)