Gov.br React UI

Este projeto é uma biblioteca de componentes ReactJS construída seguindo o padrão digital do Design System do Governo Federal. Nosso objetivo é fornecer uma coleção de componentes e interfaces UI de alta qualidade e acessíveis, que possam ser facilmente integrados em aplicações React.

Características

• ReactJS + Vite: Utilizamos a moderna ferramenta de construção Vite para um desenvolvimento mais rápido e eficiente.
• TypeScript: Garantimos a segurança de tipos com TypeScript, melhorando a manutenção e a escalabilidade do código.
• TailwindCSS: Aproveitamos a utilidade do TailwindCSS para um design responsivo e personalizável.
• Storybook: Documentamos nossos componentes com Storybook, permitindo uma visualização interativa e um teste fácil dos componentes.

Objetivos

Nosso principal objetivo é criar uma biblioteca de componentes que:

• Seja consistente com o Design System do Governo Federal.
• Promova a reutilização de código.
• Aumente a eficiência do desenvolvimento de interfaces.

Como Acessar

Para começar a usar nossa biblioteca de componentes, siga estes passos:

1. Clone o repositório:

   git clone https://github.com/atejap05/gov-br-react-ui

2. Instale as dependências:

   npm install

3. Inicie o projeto:

   npm run dev

Documentação

Para vizualizar a documentação localmente:

npm run storybook

Você também pode encontrar a documentação completa e exemplos de uso dos componentes no nosso Storybook em storybook

Contribuindo

Estamos sempre procurando contribuições para melhorar nossa biblioteca. Se você está interessado em contribuir, por favor, leia nosso CONTRIBUTING.md para mais informações sobre como começar.

Licença

Este projeto é licenciado sob a Licença MIT.