{"id":18659110,"url":"https://github.com/bush1d3v/tsbank_front","last_synced_at":"2025-04-11T20:30:47.853Z","repository":{"id":207656998,"uuid":"719203830","full_name":"bush1D3v/tsbank_front","owner":"bush1D3v","description":"Front-end da aplicação TSBank, uma aplicação bancária completa possuindo todas as transações bancárias existentes.","archived":false,"fork":false,"pushed_at":"2024-03-05T13:34:56.000Z","size":4083,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T17:48:26.274Z","etag":null,"topics":["axios","crypto-js","css3","docker","dotenv","eslint","html","jest","nodejs","postcss","prettier","react","scss","stylelint","tailwindcss","typescript","vite","vitest","yarn","zod"],"latest_commit_sha":null,"homepage":"https://tsbank.vercel.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bush1D3v.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-15T17:14:10.000Z","updated_at":"2025-03-10T23:05:33.000Z","dependencies_parsed_at":"2024-02-21T13:36:57.840Z","dependency_job_id":"9d310f87-8dbd-4703-a326-3f831271ca11","html_url":"https://github.com/bush1D3v/tsbank_front","commit_stats":null,"previous_names":["bush1d3v/tsbank_front"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bush1D3v%2Ftsbank_front","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bush1D3v%2Ftsbank_front/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bush1D3v%2Ftsbank_front/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bush1D3v%2Ftsbank_front/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bush1D3v","download_url":"https://codeload.github.com/bush1D3v/tsbank_front/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248476127,"owners_count":21110215,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["axios","crypto-js","css3","docker","dotenv","eslint","html","jest","nodejs","postcss","prettier","react","scss","stylelint","tailwindcss","typescript","vite","vitest","yarn","zod"],"created_at":"2024-11-07T07:35:49.031Z","updated_at":"2025-04-11T20:30:47.338Z","avatar_url":"https://github.com/bush1D3v.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🏦 TSBANK\n\n![License](https://img.shields.io/static/v1?label=license\u0026message=MIT\u0026color=orange) \u0026nbsp;\n![Bun version](https://img.shields.io/static/v1?label=bun\u0026message=v1.0.26\u0026color=yellow) \u0026nbsp;\n![Repository size](https://img.shields.io/github/repo-size/bush1D3v/tsbank_front?color=green) \u0026nbsp;\n![Pull request](https://img.shields.io/static/v1?label=PR\u0026message=welcome\u0026color=blue)\n\n## 🔍 Sobre o Projeto\n\nO **TSBank** é uma aplicação **bancária**, 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.\n\n## 🛠️ Tecnologias e Ferramentas Utilizadas\n\n\u003cdiv align='center'\u003e\n   \u003cimg align='center' height='50' width='70' title='TypeScript' alt='typescript' src='https://github.com/devicons/devicon/blob/master/icons/typescript/typescript-original.svg' /\u003e\n   \u003cimg align='center' height='54' width='68' title='React' alt='react' src='https://github.com/devicons/devicon/blob/master/icons/react/react-original.svg' /\u003e\n   \u003cimg align='center' height='54' width='68' title='Vite' alt='vite' src='https://github.com/bush1D3v/my_portfolio/assets/133554156/46570ed3-6e92-4ad2-b09b-d235cd142b3f' /\u003e\n   \u003cimg align='center' height='54' width='68' title='Tailwindcss' alt='tailwindcss' src='https://github.com/devicons/devicon/blob/master/icons/tailwindcss/tailwindcss-original.svg' /\u003e\n   \u003cimg align='center' height='54' width='68' title='Node.js' alt='nodejs' src='https://github.com/devicons/devicon/blob/master/icons/nodejs/nodejs-original-wordmark.svg' /\u003e\n   \u003cimg align='center' height='64' width='68' title='Sass' alt='sass' src='https://github.com/devicons/devicon/blob/master/icons/sass/sass-original.svg' /\u003e\n   \u003cimg align='center' height='68' width='72' title='Potcss' alt='potcss' src='https://github.com/bush1D3v/my_portfolio/assets/133554156/85b7c73b-e181-4c95-b9de-a8e0ba0523d3' /\u003e\n   \u003cimg align='center' height='65' width='80' title='StyledComponents' alt='styledcomponents' src='https://github.com/bush1D3v/tsbank_front/assets/133554156/5c78f0d4-45d6-407a-becc-fa25188d2491' /\u003e\n   \u003cimg align='center' height='54' width='68' title='Jest' alt='jest' src='https://github.com/devicons/devicon/blob/master/icons/jest/jest-plain.svg' /\u003e\n   \u003cimg align='center' height='70' width='50' title='Axios' alt='axios' src='https://github.com/bush1D3v/tsbank_front/assets/133554156/b9ff307f-3582-4635-ae6e-361215efc742' /\u003e \u0026nbsp;\n   \u003cimg align='center' height='54' width='44' title='Vitest' alt='vitest' src='https://github.com/bush1D3v/tsbank_api/assets/133554156/74803ee6-3f6e-4335-9f56-cb887a4285ff' /\u003e  \u0026nbsp;\n   \u003cimg align='center' height='54' width='54' title='React Hook Form' alt='react hook form' src='https://github.com/bush1D3v/tsbank_front/assets/133554156/65a90eb9-1188-4197-a902-6b055464cc76' /\u003e \u0026nbsp;\n   \u003cimg align='center' height='54' width='68' title='Html5' alt='html5' src='https://github.com/devicons/devicon/blob/master/icons/html5/html5-original.svg' /\u003e\n   \u003cimg align='center' height='50' width='70' title='JavaScript' alt='javascript' src='https://github.com/devicons/devicon/blob/master/icons/javascript/javascript-original.svg' /\u003e\n   \u003cimg align='center' height='58' width='80' title='Tailwindcss-animated' alt='tailwindcss-animated' src='https://github.com/bush1D3v/my_portfolio_html/assets/133554156/364156ca-f265-4478-bcc3-4a12830c46a7' /\u003e \u0026nbsp;\n   \u003cimg align='center' height='49' width='49' title='Dotenv' alt='dotenv' src='https://github.com/bush1D3v/my_portfolio/assets/133554156/432ec521-c94a-4f24-964e-f62658d04581' /\u003e \u0026nbsp; \u0026nbsp;\n   \u003cimg align='center' height='49' width='59' title='Zod' alt='zod' src='https://github.com/bush1D3v/tsbank_front/assets/133554156/5a769805-23e2-4f8b-904d-034b25a982a6' /\u003e \u0026nbsp; \u0026nbsp;\n   \u003cimg align='center' height='49' width='49' title='Crypto-js' alt='crypto-js' src='https://github.com/bush1D3v/tsbank_api/assets/133554156/303e55f6-c252-479d-9ce9-37cb33b07a12' /\u003e \u0026nbsp; \u0026nbsp;\n   \u003cimg align='center' height='54' width='44' title='Storybook-js' alt='storybook-js' src='https://github.com/bush1D3v/my_portfolio/assets/133554156/213c8aa4-ce24-4b30-8e07-dceb476e8589' /\u003e \u0026nbsp;\n   \u003cimg align='center' height='70' width='70' title='Docker' alt='docker' src='https://github.com/devicons/devicon/blob/master/icons/docker/docker-plain.svg' /\u003e \u0026nbsp;\n   \u003cimg align='center' height='60' width='60' title='Miro' alt='miro' src='https://github.com/bush1D3v/tsbank_front/assets/133554156/a13c4c2a-892e-4f34-911d-71630ce7a35d' /\u003e\n\u003c/div\u003e\n\n## 🏗 Estrutura e Arquitetura\n\nO 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**.\n\n## 📃 Documentação da Aplicação\n\nA seguir, temos o link da documentação Front-end feita a partir do Storybook: \u003chttps://tsbank-storybook.vercel.app/\u003e\n\n## 🐳 Docker\n\nCom 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.\n\nPara isso, segue a lista de funções de cada script:\n\n\u003e `docker-build`: Constrói a imagem docker do projeto \u003cbr\u003e `docker-start`: Sobe e roda/só roda o container tsbank_front \u003cbr\u003e `docker-stop`: Para o container tsbank_front \u003cbr\u003e `docker-test`: Sobe um container alternativo chamado tsbank_front_tests, roda os testes e exclui o container após a execução dos mesmos \u003cbr\u003e `docker-stb`: Sobe um container alternativo chamado tsbank_front_stb, e após a documentação ser fechada pelo seu terminal VSCode com \u003cu\u003ectrl + c\u003c/u\u003e, o container é excluído\n\n## 🎨 Miro\n\nCom a adição do Miro, foi criado o **fluxograma** do TSBank. Abaixo, segue o link de visualização: \u003chttps://miro.com/app/board/uXjVNmeu-5k=/?share_link_id=758188566721\u003e\n\n# 🖋️ Contribuindo para o TSBank\n\nAgradecemos pelo seu interesse em contribuir para a **TSBank**. Sua ajuda é **valiosa** para melhorar e **expandir** nossa aplicação. Abaixo estão as **diretrizes** e os **passos** para contribuir com nosso projeto.\n\n## 💻 Como Contribuir\n\n### 🌳 Forkando o Repositório\n\nAntes de começar, você **deverá** forkar o repositório do projeto para **seu perfil**.\n\n### 🖨 Clonando seu Repositório\n\nApós o Fork, você **precisará** clonar o repositório forkado para seu **ambiente de desenvolvimento local**:\n\n```\ngit clone https://github.com/{seu-usuario}/tsbank_front.git\ncd tsbank_front\n```\n\n### ⏬ Instalando Dependências\n\nCertifique-se de ter Node.js instalado no seu sistema. Em seguida, instale as dependências necessárias:\n\n```\nnpm install\n```\n\nou\n\n```\nyarn install\n```\n\nou\n\n```\npnpm install\n```\n\n### 🆕 Criando uma Branch\n\nAntes de iniciar qualquer trabalho, crie uma branch separada para a sua contribuição. Use um nome descritivo para a sua branch:\n\n```\ngit checkout -b feature/nova-funcionalidade\n```\n\n### 🔨 Fazendo Alterações\n\nFaça as alterações necessárias no código, adicione novos recursos ou correções de bugs.\n\n### 🧪 Testando\n\nGaranta que suas alterações não quebraram nenhum recurso existente. Execute os testes e certifique-se de que todos passam:\n\n```\nnpm run test\n```\n\nou\n\n```\nyarn test\n```\n\nou\n\n```\npnpm test\n```\n\n### 📝 Documentando\n\nMantenha 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 no servidor StoryBook.\n\n### 📊 Compromissos e Push\n\nApós concluir suas alterações e testá-las, faça um commit das alterações:\n\n```\ngit add .\ngit commit -m \u003ctipo de alteração\u003e(nomeDoArquivo): Nova funcionalidade\n```\n\nEm seguida, envie suas alterações para o repositório:\n\n```\ngit push origin feature/nova-funcionalidade\n```\n\n### 📨 Solicitando um Pull Request (PR)\n\nVá 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.\n\n### 👁 Revisão e Fusão\n\nApó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.\n\n## 💼 Diretrizes Gerais\n\n- Mantenha o código limpo e legível.\n- Siga as boas práticas de desenvolvimento.\n- Respeite as convenções de nomenclatura existentes.\n- Documente adequadamente as alterações, recursos ou correções.\n\n#\n\n**_Agradecemos pela sua contribuição e esperamos trabalhar juntos para tornar a TSBank 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._**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbush1d3v%2Ftsbank_front","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbush1d3v%2Ftsbank_front","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbush1d3v%2Ftsbank_front/lists"}