Minha Vacina Frontend

Requisitos   |    Tecnologias   |    Como usar   |    Scripts disponíveis

📝 Requisitos

Ferramenta	Versão	Descrição
NodeJS	16.14.0	Ambiente de execução Javascript server-side
Yarn	1.22.17	Gerenciador de pacotes JS
Git

🚀 Tecnologias

Este projeto está sendo desenvolvido com as seguintes tecnologias:

• Linguagem: Typescript;
• Biblioteca JS para front-end: ReactJS;
• HTTP client: Axios;
• Estilização: Styled-Components + React-Icons + Polished;
• Rotas: react-router-dom v6;
• Padronização: EditorConfig + ESLint + Prettier;
• Git Hook: Husky + Lint-Staged + Commit lint;
• Testes: Jest + React-Testing-Library;
• Documentação: Storybook;

ℹ️ Como usar

É necessário criar o .env seguindo o padrão das variáveis de ambiente do .env.example

# Clonar este repositório
$ git clone https://github.com/Guilherme-Farias/vaccine-scheduler-frontend
# Ir para o repositório
$ cd vaccine-scheduler-frontend
# Instalar as dependências
$ yarn install
# Rodar a aplicação em ambiente de desenvolvimento
$ yarn start

📜 Scripts disponíveis

• start: Inicia a aplicação;
• build: Build da aplicação;
• test: Realiza os testes de toda a aplicação;
• test:watch: Realiza os testes e fica assistindo por mudanças nos arquivos;
• test:coverage: Realiza todos os testes verificando a cobertura de testes em todos os arquivos;
• eject: Ejeta o CRA;
• generate: Utilitário para criar componente com os seus devidos arquivos (Teste, Documentação, Estilo e exportador);
• prepare: Inicializa o Husky;
• lint: Escaneia a aplicação verificando e consertando erros nas aplicação;
• sb: Inicializa a documentação do Storybook no localhost:6006;
• sb:build: Build do Storybook;