Wizard UI

Uma interface web genérica para a configuração inicial (contratação) de qualquer coisa.

Tecnologias

• Node.js v16.x
• Next.js
• chakra
• next-intl

Development server

# install
yarn
# launch dev server on localhost:3000
yarn dev

Contribuições

Este repositório pode estar espelhado em outros lugares, para contribuir com melhorias ou relatar problemas, utilize a página deste projeto no Github: https://github.com/jaxyendy/wizard-ui

Se você está lendo este README fora do Github, não deixe de ler também o arquivo DISTRO.md.

Licença

A definir. (gostamos muito da AGPL3, mas MIT pode ser mais flexível)

Fluxos

Telas da UI

stateDiagram-v2
    state valid_token <<choice>>
    [*] --> valid_token
        valid_token --> acess_denied: token inválido
        valid_token --> welcome: token válido
    state have_contract <<choice>>
    welcome --> have_contract: contrato
        have_contract --> contract_details: contract_id
        have_contract --> contract_form: não tenho
    contract_form --> contract_details: envio OK
    contract_details --> end_contract_form: cancelar contrato
    end_contract_form --> inactive_contract_detail: envio OK
    welcome --> inactive_contracts: contratos encerrados
    inactive_contracts --> inactive_contract_detail: inactive_contract_id
    inactive_contract_detail --> [*]
    state contract_form {
        [*] --> step_1
        step_1 --> ...
        ... --> step_n
        step_n --> [*]
    }

Biblioteca de Componentes

Este projeto, além de ser um site NextJS, é também uma biblioteca dos componentes usados por este site.

A lista dos componentes exportados pode ser vista no arquivo /lib/index.ts.

Este pacote npm é exportado sem transpilação, portanto para utilizar estes componentes em um outro projeto NextJS recomendamos o uso do plugin next-transpile-modules ou alguma outra técnica similar.

Para ajudar com o teste e desenvolvimento de componentes em conjunto com outros projetos NextJS localmente, antes da publicação no registry npm, uma ferramenta como o yalc pode também ser útil.