Skip to content

miguelsndc/browk-ui-kit

Repository files navigation

Browk UI KIT

About The Project

As a quite new frontend developer, i'm used to build a project from the ground up, but that's not how things work in a real work environment. That's why i decided to learn Storybook, a awesome tool that help us fronties build, test and validate ui components in isolation, which really makes the job easier. As a real world tool, i believe that the knowledge i acquired now will help me a lot in the future.

Take a look at the hosted project here, i'm updating it constantly.

Here's what i learned:

  • What is and how to use Storybook
  • Use Chromatic to deploy Storybook

Built With

This project is built with the following technologies:

Getting Started

To get a local copy of this project 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.

Installation

  1. Clone the repo

    git clone <https://github.com/miguelsndc/browk-ui-kit.git>
    
    
  2. Install NPM packages

    npm install // yarn
    
    
  3. Start the project

    npm run storybook // yarn storybook
    
    

Contributing

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

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

License

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

Contact

Miguel Nogueira - Linkedin - mglsndc@gmail.com

Project Link: Live Project Here