AlexandreFPGoncalves

React Component Library Itsector Workshop
Explore the Wiki »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
     • Install and Run the component library
     • Install and Run Mock Application
3. Packages Used
4. License
5. Contact
6. Acknowledgments

About The Project

Project created for a presentation about Design Systems, Storybook and creating of a react component library.

• This Project contains two sub-projects one regarding the storybook and the component library itself, where you maintain and change the components locally and where finally you can update the npm version;
  
• The other application is mainly used to update the npm version and see the changes live.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Have the latest LTS npm version installed on your machine from this website.

Installation

1. Clone the repository

   git clone https://github.com/AlexandreFPGoncalves/react-component-library-itsector-workshop.git

Install and Run the component library

1. Navigate into the companyLibrary folder

   cd .\ComponentLibrary\

2. Install NPM packages

   npm install

3. Run Storybook

   npm run storybook

Install and Run Mock Application

1. Navigate into the companyLibrary folder

   cd .\MockApplication\

2. Install NPM packages

   npm install

3. Run application

   npm run dev

(back to top)

Packages used

1. React Component Library ItSector Workshop | Main package especially created for this workshop.
   

2. Phosphor-react | Phosphor is a flexible icon family for interfaces, diagrams, presentations, etc.

(back to top)

License

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

Contact

Alexandre Gonçalves | Linkedin | [email protected]

Project Link: AlexandreFPGoncalves/react-component-library-itsector-workshop

Acknowledgments

Thanks to Humberto Vieira who presented this workshop with me last monday [07/11/2022] for all the help he provided and the memory we both created that day.

(back to top)