Este projeto é uma biblioteca UI baseada em Web Components e TypeScript, projetada para facilitar a criação de páginas de fluxo em aplicações web. Ele fornece componentes reutilizáveis e customizáveis que podem ser facilmente integrados em qualquer projeto web.
Para começar a usar a biblioteca, você pode instalá-la via npm ou yarn:
npm install vanilla-flow-ts # ou yarn add vanilla-flow-ts
Após a instalação, você pode importar os componentes desejados em seu projeto e começar a usá-los. Por exemplo:
import FlowChart, { BoardEdgeProps, BoardNodeProps } from "./components/Board"; // Use FlowChart em seu código
Para iniciar o desenvolvimento local, siga estas etapas:
- Clone este repositório:
git clone https://github.com/seu-usuario/seu-repositorio.git
- Navegue até o diretório do projeto:
cd meu-biblioteca-ui
- Instale as dependências:
yarn install
- Inicie o ambiente de desenvolvimento:
yarn dev
Este comando iniciará um servidor de desenvolvimento local e abrirá automaticamente o seu navegador padrão com a aplicação em execução.
Para construir a biblioteca para produção, execute o seguinte comando:
yarn build
Isso criará uma versão otimizada da biblioteca na pasta dist, pronta para ser utilizada em produção.
Contribuições são bem-vindas! Sinta-se à vontade para abrir problemas (issues) ou enviar pull requests com melhorias.
Para publicar é necessário digitar os comandos
yarn build
Este projeto está licenciado sob a MIT License.