Guias

Publicar na galeria

Os templates da galeria vivem no repositório. Publicar é abrir um pull request com uma pasta.

templates/
templates/<nome>/
  meta.json         nome, descrição, autor, versão, tipos de documento, etiquetas
  template.tsx        o template em React + Tailwind
  template.json       o mesmo template compilado (gerado)
  preview-ft.webp   pré-visualizações de cada tipo de documento (geradas)
  …

Passos#

  • Faz fork de Eterim/vero-template e cria templates/<nome>/ com meta.json e template.tsx.
  • Vê-o com npx @veroao/invoice dev templates.
  • Gera o JSON e as imagens com npm run templates -w packages/invoice -- <nome>.
  • Verifica com npm run check:templates -w packages/invoice -- <nome> - é o que a CI corre.
  • Abre o pull request. A CI repete as verificações e alguém da equipa revê o template.

Regras#

  • Todos os elementos obrigatórios da AGT presentes.
  • No meta.json, o teu utilizador do GitHub em author.name e "collection": "comunidade". Ao alterar um template, sobe a version.
  • Nada de números de conta, telefones, NIF, ligações, e-mails ou menções fiscais escritos no template - vêm sempre dos dados da empresa e dos componentes.
  • Sem logótipo, nome ou dados de uma empresa real - o logótipo vem da empresa que usar o template.
  • Licença MIT.