Skip to content

wilsonfsouza/ignite-call-design-system

Repository files navigation

GitHub top language GitHub last commit Made by Wilson Franca

Ignite Call Design System

Table of contents

AboutFeaturesHow to runTechnologiesAuthor

💻 About the project

Ignite Call UI is a design system for an online scheduling platform.

The design system uses npm workspaces to separate the documentation, react components, tokens, and typescript and eslint configuration in different packages.


🔥 Preview

The documentation was deployed on Github pages using a CI/CD pipeline. To see the available tokens and components, see:


⚙️ Features

Components available:

  • Avatar
  • Button
  • Checkbox
  • Heading
  • MultiStep
  • Text
  • Textarea
  • TextInput
  • Toast (In Progress)
  • Tooltip

🚀 How to run the project

Requirements

Initial requirements: git, npm, and a code editor of your choice.

Running the application

# Clone this repository
$ git clone git@github.com:wilsonfsouza/ignite-call-design-system.git

# Access the folder in your terminal/cmd/cli
$ cd ignite-call-design-system

# Install all dependencies
$ npm install

# Start the app in development mode
$ npm run dev

# The storybook application will open at port:6006 - access http://localhost:6006/?path=/story/home--page

🛠 Technologies

The following tools were used in this project:

See global and individual packages package.json file for more details

Use node version 16.10 to run this project


💪 How to contribute to this project

  1. Fork the project.
  2. Start a new branch with your changes: git checkout -b my-new-feature
  3. Save it and create a commit message describing what you have done: git commit -m "feature: My new feature"
  4. Send your alterations: git push origin my-feature

👨‍💻 Author



Wilson Franca


Linkedin Badge Gmail Badge


Made with ❤️ by Wilson Franca 👋