Um parágrafo da descrição do projeto vai aqui
• Tecnologias
• Pré requisitos
• Rodando a aplicação
• Executando os testes
• Colaborando
• Licença
O yourFinance é um software para gerenciamento e controle de finanças pessoais!
O projeto foi desenvolvido com o intuito de eliminar a utilização de planilhas para gerenciamento de controle financeiro. Com o armazenamento das informações através de transações, que são chamadas de movs, e podem ser definidas através de categorias, modalidades e tipo. A partir das definições do usuário, o projeto apresenta algumas informações em tela, e realiza determinadas análises da usabilidade do usuário.
Tecnologias e ferramentas utilizadas no desenvolvimento do projeto:
Mobile ( React Native + TypeScript )
- Protótipo: Figma
- Fontes: Gotham
- Editor: Visual Studio Code → Extensions: Prettier + EditorConfig
- Versionamento: Git
- Padronização de código: ESLint
O layout do projeto foi pensado para ser o mais clean possível, mantendo poucos elementos visuais e alinhado com a expectativa do usuário.
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
→ Git;
→ Node.js;
💡 O Frontend precisa que o Backend esteja sendo executado para funcionar.
# Clone este repositório
$ git clone https://github.com/yourFinanceApp/mobile.git
# Vá para a pasta da aplicação Mobile
$ cd mobile
# Instale as dependências
yarn installApós a instalação das dependências, atualize o arquivo httpClient com a url e porta onde o back-end esta rodando localmente.
class HttpClient {
private baseURL;
constructor(baseURL = 'url-back-end') {
this.baseURL = baseURL;
}
}
Logo após, você já pode rodar a aplicação com os comandos abaixo.
# Inicie o projeto com expo
$ yarn start
# Selecione a plataforma para inicializar o projeto
# A aplicação será inicializada na plataforma selecionadaPara rodar todos os testes no repositório, utilize:
yarn test
Caso seja necessário rodar apenas um único teste, utilize:
yarn test <nome-do-arquivo>.spec.tsx
Os testes são construídos utilizando o Triple AAA(Arrange, Act, Assert). Esses sistema consiste em uma metodologia comumente utilizada para escrever testes unitários estruturados e bem organizados. Sendo:
-
Arrange(Preparação) Nesta etapa você define o cenário de teste, preparando o ambiente, realizando os mocks necessários para realizar o teste, e as definições de entrada de teste.
-
Act(Execução) Nesta etapa, você executa a ação ou o comportamento que está sendo testado. Podendo ser a chamada de uma função, interação com objeto, ou qualquer outra operação que esta sendo testada.
-
Assert(Verificação) Nesta etapa, você verifica se o resultado obtido após a execução esta de acordo com o esperado
A metodologia triple AAA promove uma estrutura clara e organizada para os testes, tornando mais legíveis, fáceis de entender e de fácil manutenção. Garantindo uma clareza sobre o que esta sendo testado e cada etapa do teste.
import React from 'react';
import { render, fireEvent } from '@testing-library/react-native';
import MyComponent from './MyComponent';
test('Incrementa o contador ao pressionar o botão', () => {
// Arrange
const { getByText } = render(<MyComponent />);
const incrementButton = getByText('Incrementar');
const counterText = getByText('Contador: 0');
// Act
fireEvent.press(incrementButton);
// Assert
expect(counterText).toHaveTextContent('Contador: 1');
});
Por favor, leia o COLABORACAO.md para obter detalhes sobre o nosso código de conduta e o processo para nos enviar pedidos de solicitação.
Este projeto está sob a licença MIT - veja o arquivo LICENSE.md para detalhes.
Agradecemos às seguintes pessoas que contribuíram para este projeto:
 Vitor Sousa |
 João Lucas |