spe-shell

super-portal-empregador-shell

super-portal-empregador-shell

Informações estruturais

Aqui você irá registrar informações estruturais do projeto, podendo ser uma lista de links conforma abaixo:

• Protótipo Adobe XD
• Documentação do confluence
• Documentação de arquitetura
• Definições de negócio
• Mural

Setup do projeto

Aqui você irá colocar informações sobre como realizar o setup do projeto, além de listar pré requisitos e outras informações que julgar importante para que o dev possa rodar o projeto localmente.

Requisitos (se houver)

Aqui você irá mencionar os requisitos necessários para rodar o projeto, por exemplo, versão do node, instalar algum software específico, etc

• Node >= 16
• Ter o cocoapods instalado e configurado

Inicialização do projeto

Aqui você irá incluir informações dos passos necessários para rodar o projeto

Instalando dependências do projeto

npm ci

Rodando o projeto

npm run start

Rodando os testes do projeto

npm run test

Como usar? (se houver)

Alguns projetos podem necessitar de informações adicionais de como utilizá-lo. Projetos que exportam libs ou então projetos de Microfrontend pode ser necessário inserir exemplos de como utilizar esse determinado projeto.

import { Componente } from "@vr/lib-qualquer";

export default function App() {
  return <Componente propQualquer="Teste" />;
}

Como contribuir?

Alguns projetos podem possuir formas específicas de como contribuir para seu desenvolvimento, pensando nisso neste espaço você deverá detalhar como pode contribuir desenvolvendo features, corrigindo bugs, etc.

• Clone o repositório;
• Criar uma branch seguindo o padrão Nomenclatura de Branchs
• Realize os ajustes nos arquivos necessários;
• Realizar um commit seguindo o Conventional Commits;
• Criar um Pull Request;
• Beba água.🚰

Tecnologias utilizadas

Aqui você poderá listar as tecnologias utilizadas em seu projeto

• React
• React Hook Form
• Redux
• Redux Saga

Links úteis (opcional)

Aqui você poderá inserir links úteis para seu projeto, como por exemplo links para documentação de alguma biblioteca ou algum outro link que julgar importante

• https://redux-saga.js.org/
• https://react-hook-form.com/

Troubleshooting (opcional)

Aqui você pode listar resoluções de possíveis problemas comuns de acontecer quando o desenvolvedor for rodar o projeto pela primeira vez em sua máquina. Os problemas aqui listados devem ser específicos do projeto. Caso seja algum problema de setup de aplicação ou algum outro que afeta mais de um projeto, procure direcionar para as páginas de Troubleshooting presentes no Chapter de Frontend no confluence.