@evolution-soft/ui 1.0.0

package/README.md

@@ -0,0 +1,127 @@
+# @evolutionsoft/ui
+
+Biblioteca de componentes oficial da Evolutionsoft — construída sobre **shadcn/ui**, **Tailwind CSS v4**, **Radix UI**, **Framer Motion** e **Lottie**.
+
+Centraliza, documenta e padroniza os componentes utilizados nas aplicações da empresa, garantindo consistência visual e reutilização de código.
+
+---
+
+## 📦 Utilizar no projeto (como consumidor)
+
+### 1. Instalação
+
+```bash
+npm install @evolutionsoft/ui
+```
+
+> O pacote tem `react`, `react-dom` e `next` (opcional) como **peer dependencies** — certifica-te de que já estão instalados no projeto.
+
+### 2. Importar os estilos globais
+
+No ficheiro raiz do projeto (ex: `app/layout.tsx`, `main.tsx` ou `_app.tsx`):
+
+```ts
+import '@evolutionsoft/ui/styles.css';
+```
+
+### 3. Importar componentes
+
+```tsx
+import { Button, Title, Subtitle, TooltipIndicator, LottieIcon } from '@evolutionsoft/ui';
+
+export default function Page() {
+  return (
+    <>
+      <Title size="xl">Olá, Evolutionsoft!</Title>
+      <Button variant="outline">Clique aqui</Button>
+    </>
+  );
+}
+```
+
+### 4. Providers necessários (opcional)
+
+Se usares `SettingsModal` ou `ButtonIconLottie`, envolve a aplicação com o `AnimationSettingsProvider`:
+
+```tsx
+import { AnimationSettingsProvider } from '@evolutionsoft/ui';
+
+export default function RootLayout({ children }) {
+  return (
+    <AnimationSettingsProvider>
+      {children}
+    </AnimationSettingsProvider>
+  );
+}
+```
+
+---
+
+## 🛠️ Desenvolver e publicar (como mantenedor)
+
+### Pré-requisitos
+
+- [Node.js](https://nodejs.org/) v20+
+- Conta no [npm](https://www.npmjs.com/) com acesso à org **evolutionsoft**
+
+### Setup local
+
+```bash
+git clone https://vitorkravs@bitbucket.org/evolutionsoftteam/evolution-backoffice-storybook.git
+cd evolution-backoffice-storybook
+npm install
+```
+
+### Desenvolvimento
+
+```bash
+npm run dev          # Vite dev server com preview de componentes
+npm run storybook    # Storybook em localhost:6006
+```
+
+### Build da biblioteca
+
+```bash
+npm run build        # Gera dist/ com ESM + CJS + tipos
+```
+
+### Publicar nova versão no npm
+
+```bash
+# 1. Login (apenas uma vez por máquina)
+npm login
+
+# 2. Actualizar a versão em package.json:
+#    patch: 1.0.0 → 1.0.1  |  minor: 1.0.0 → 1.1.0  |  major: 1.0.0 → 2.0.0
+npm version patch   # ou minor / major
+
+# 3. Build + publish (o prepublishOnly corre automaticamente)
+npm publish --access public
+```
+
+> Após o publish, os consumidores atualizam com `npm update @evolutionsoft/ui`.
+
+---
+
+## 🏗️ Tecnologias
+
+| Tecnologia | Função |
+|---|---|
+| [Vite](https://vitejs.dev/) | Build e dev server |
+| [Tailwind CSS v4](https://tailwindcss.com/) | Utilitários de CSS |
+| [shadcn/ui](https://ui.shadcn.com/) | Componentes base |
+| [Radix UI](https://www.radix-ui.com/) | Primitivos acessíveis |
+| [Framer Motion](https://www.framer.com/motion/) | Animações |
+| [Lottie React](https://github.com/LottieFiles/lottie-react) | Ícones animados |
+| [TypeScript](https://www.typescriptlang.org/) | Tipagem |
+
+---
+
+## ✒️ Autores
+
+- **Vitor Cesar Kravszenko** — [vitorkravs](https://github.com/vitorkravs)
+- **Evolutionsoft** — [evolutionsoft.com.br](https://evolutionsoft.com.br/)
+
+## 📄 Licença
+
+Todos os direitos reservados à [Evolutionsoft](https://evolutionsoft.com.br/). Uso sujeito a autorização prévia da empresa.