1.0.6 • Published 11 months ago

leedz-design-system v1.0.6

Weekly downloads
-
License
ISC
Repository
github
Last release
11 months ago

Leedz Logo

Leedz Design System

NPM version Build Status License

Leedz Design System é uma biblioteca de componentes reutilizáveis para React, criada para facilitar a construção de interfaces de usuário consistentes e acessíveis.

📦 Instalação

Você pode instalar o pacote via npm ou yarn:

npm install leedz-design-system

ou

yarn add leedz-design-system

🚀 Uso

Aqui está um exemplo básico de como usar o Leedz Design System em um projeto React:

import React from 'react';
import { ThemeProvider } from 'styled-components';
import { Container, Button, theme } from 'leedz-design-system';

function App() {
  return (
    <ThemeProvider theme={theme}>
      <Container padding="20px">
        <h1>Hello, Leedz!</h1>
        <Button variant="primary">Primary Button</Button>
        <Button variant="secondary">Secondary Button</Button>
      </Container>
    </ThemeProvider>
  );
}

export default App;

📚 Documentação

A documentação completa do Leedz Design System está disponível no Storybook.

🔧 Desenvolvimento

Pré-requisitos

  • Node.js
  • npm ou yarn

Clonando o repositório

git clone https://github.com/Leedz-Digital/leedz-design-system.git
cd leedz-design-system

Instalando dependências

npm install

ou

yarn install

Executando o Storybook

npm run storybook

ou

yarn storybook

🛠 Estrutura do Projeto

  • src/components: Contém todos os componentes do design system.
  • src/styles: Contém temas e estilos globais.
  • .storybook: Configurações do Storybook.

🤝 Contribuindo

Contribuições são bem-vindas! Por favor, siga as diretrizes de contribuição descritas no CONTRIBUTING.md.

📜 Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para mais detalhes.

📞 Contato

Para mais informações, visite nosso site ou entre em contato pelo email.


Feito com ❤️ pela equipe Leedz Digital.