naveteam / Saturn

Repositório de componentes React baseado no design system da Nave.

❗️ Motivação

Diversas vezes precisamos prototipar rapidamente novas aplicações e sempre precisamos recorrer à libs de componentes de layout como Material UI ou Ant Design.

A criação de um design system próprio pode aumentar a familiaridade da equipe com determinado padrão de código, fazendo com que gradativamente esses protótipos sejam criados de forma mais rápida e homogênea, abstraindo a necessidade de se preocupar com o layout que a aplicação terá.

🛠 Tecnologias utilizadas

Baseamos nosso desenvolvimento em:

• React
• Styled Components
• Styled System
• Storybook

🚀 Instalação

No terminal, execute

yarn add @naveteam/saturn
// ou npm install @naveteam/saturn

💡 Utilização

Com a lib instalada, o seguinte código já é o suficiente para iniciar o desenvolvimento da aplicação

import React from 'react'
import ReactDOM from 'react-dom'
import { ThemeProvider, TextField } from '@naveteam/saturn'

const App = () => {
  return (
    <ThemeProvider>
      <TextField name='base' label='Label' message='Message' placeholder='Placeholder' />
    </ThemeProvider>
  )
}

ReactDOM.render(<App />, document.getElementById('root'))

Você pode encontrar em nosso Storybook a documentação necessária de todos os componentes disponíveis no projeto.

🤝 Contribuição

Sinta-se livre para contribuir com o projeto, criando novos componentes, abrindo PRs para ajustar bugs ou mesmo levantando dúvidas, sugestões ou pedidos de ajustes através de issues. Para contribuir com nosso projeto, por favor siga nosso guia de CONTRIBUTING.

📚 Links úteis

• Figma: Onde todo o design do projeto se encontra
• Chromatic: Local onde ocorre a revisão dos componentes pelo time de degisn
• NPM: Acesso ao pacote NPM do projeto
• Github: Repositório da lib
• Storybook: Página com o projeto mais atualizado para referência
• Miro: Resumo do Workflow de desenvolvimento de um componente
• Roadmap: Link do projeto do GitHub com o andamento do desenvolvimento

🐛 Bugs Conhecidos

O Storybook não renderiza PropTypes passadas dinamicamente para meu componente

Isso é uma limitação do Addon do Storybook responsável por criar a tela de Docs. Esse comportamento já foi reportado e existe uma issue aberta para tratar essa questão aqui. Enquanto esse problema não é resolvido, você pode declarar as PropTypes do Styled System de forma estática, ou informar na descrição do componente quais módulos do Design System estão importados no componente.

Contribuidores ✨

Obrigado a essas maravilhosas pessoas que contribuíram de alguma maneira para o desenvolvimento da lib (emoji key):

Eduardo Bittencourt 📖 💻 🤔 🚧 👀 🐛 💡 🚇 📢	Daniel Pôrto Nuñez 💻 🐛 📖 💡 🤔 🚧 👀	Matheus Figueiredo 💻 🤔 🚧 👀	Gabriel Do Couto Santos 📖	Caio Silva 🐛 📖 🖋	Thiago Nunes Batista 💻 📖 💡	Rafael Schumacher 💻 📖 💡 👀
Juliano Reis 👀	Ítalo Nolasco 💻 🚧	Matheus Cruz 💻 📖 💡 🚧 👀	Matheus Cruz 💻 🚧 👀	Vítor Tavares 💻 🚧 👀 📖

Esse projeto segue a especificação de all-contributors. Qualquer tipo de contribuição será bem-vinda!

Licença

MIT © Nave Team