Aurora ✨

A aurora boreal é um fenômeno luminoso que se desenvolve na termosfera (ou ionosfera), uma das camadas superiores da atmosfera do planeta Terra, que se estende de uma altura mínima de 60 km a partir da superfície até 1000 km. Essa camada está situada entre a exosfera e a mesosfera.

O Projeto Aurora é uma abordagem estruturada e abrangente para o Design System dos projetos Consumidor Positivo e Acordo Certo, criado com o objetivo de padronizar e otimizar a experiência do usuário em ambas as plataformas. Este sistema de design consiste em uma biblioteca de componentes reutilizáveis, diretrizes de estilo, padrões de interação e documentação detalhada para garantir consistência e eficiência no desenvolvimento e design de interfaces.

Tech Stack

• Reactjs ( JS lib )
• Typescript ( Types )
• Vitejs ( Tooling )
• Sass ( CSS )
• Storybook ( UI )

Sites

Consumidor Positivo

• https://www.consumidorpositivo.com.br/

Acordo Certo

• https://www.acordocerto.com.br/

Instalação e Uso

Instalação Básica

npm install @consumidor-positivo/aurora

Componentes Opcionais

Alguns componentes requerem dependências adicionais que não são instaladas por padrão para evitar aumentar o bundle desnecessariamente.

Carousel

O componente Carousel requer a instalação do react-snap-carousel:

npm install react-snap-carousel

import { Carousel } from '@consumidor-positivo/aurora'

// Agora você pode usar o Carousel
<Carousel items={items} />

Nota: Se você tentar usar o Carousel sem instalar o react-snap-carousel, receberá um erro de dependência em tempo de execução.

Testes

Este projeto usa Vitest para testes unitáriåos e @testing-library/react para testes de componentes React.

execute os testes com:

npm test

Para rodar no modo watch:

npm run test:watch