bush1d3v/tsbank_app

Aplicativo mobile do TSBank, um app bancário completo possuindo todas as transações bancárias existentes.

🏦 TSBANK APP

     

🔍 Sobre o Projeto

O TSBank APP é uma aplicação mobile do nosso queridíssimo TSBank, possuindo todas as funcionalidades existentes de um banco, como saque, depósito, pix, cartões de crédito e débito, gerenciamento de transações e informações do seu usuário, etc.

🛠️ Tecnologias e Ferramentas Utilizadas

                        

🏗 Estrutura e Arquitetura

O projeto segue os princípios da arquitetura limpa e o código foi organizado de acordo com os princípios de modularidade, reutilização e responsabilidade única.

🐳 Docker

Com a adição do Docker, você agora pode utilizar dos scripts fornecidos em package.json para poder construir a imagem docker e rodar os containers da aplicação, dos testes e da documentação.

Para isso, segue a lista de funções de cada script:

docker-build: Constrói a imagem docker do projeto
docker-start: Sobe e roda/só roda o container tsbank_app
docker-stop: Para o container tsbank_app

🎨 Miro

Com a adição do Miro, foi criado o fluxograma do TSBank. Abaixo, segue o link de visualização: https://miro.com/app/board/uXjVNmeu-5k=/?share_link_id=758188566721

🖋️ Contribuindo para o TSBank APP

Agradecemos pelo seu interesse em contribuir para o TSBank APP. Sua ajuda é valiosa para melhorar e expandir nossa aplicação. Abaixo estão as diretrizes e os passos para contribuir com nosso projeto.

💻 Como Contribuir

🌳 Forkando o Repositório

Antes de começar, você deverá forkar o repositório do projeto para seu perfil.

🖨 Clonando seu Repositório

Após o Fork, você precisará clonar o repositório forkado para seu ambiente de desenvolvimento local:

git clone https://github.com/{seu-usuario}/tsbank_app.git
cd tsbank_app

⏬ Instalando Dependências

Certifique-se de ter Node.js instalado no seu sistema. Em seguida, instale as dependências necessárias:

npm install

ou

yarn install

ou

pnpm install

🆕 Criando uma Branch

Antes de iniciar qualquer trabalho, crie uma branch separada para a sua contribuição. Use um nome descritivo para a sua branch:

git checkout -b feature/nova-funcionalidade

🔨 Fazendo Alterações

Faça as alterações necessárias no código, adicione novos recursos ou correções de bugs.

🧪 Testando

Garanta que suas alterações não quebraram nenhum recurso existente. Execute os testes e certifique-se de que todos passam:

npm run test

ou

yarn test

ou

pnpm test

📝 Documentando

Mantenha a documentação atualizada. Se você adicionou novos recursos, adicione arquivos de documentação (caso necessário) e verifique se eles estão devidamente documentados.

📊 Compromissos e Push

Após concluir suas alterações e testá-las, faça um commit das alterações:

git add .
git commit -m <tipo de alteração>(nomeDoArquivo): Nova funcionalidade

Em seguida, envie suas alterações para o repositório:

git push origin feature/nova-funcionalidade

📨 Solicitando um Pull Request (PR)

Vá para o repositório no GitHub e crie um Pull Request para que sua contribuição seja revisada. Certifique-se de descrever suas alterações e fornecer informações contextuais.

👁 Revisão e Fusão

Após criar um Pull Request, nossa equipe revisará suas alterações e fornecerá feedback. Uma vez aprovado, suas alterações serão mescladas no projeto principal.

💼 Diretrizes Gerais

• Mantenha o código limpo e legível.
• Siga as boas práticas de desenvolvimento.
• Respeite as convenções de nomenclatura existentes.
• Documente adequadamente as alterações, recursos ou correções.

Agradecemos pela sua contribuição e esperamos trabalhar juntos para tornar o TSBank APP ainda melhor. Se você tiver alguma dúvida ou precisar de ajuda, não hesite em entrar em contato conosco. Juntos, podemos criar uma aplicação mais robusta e eficiente.