🐝 Bee bank 💵

🌐 English README below the portuguese

Sobre • Começando

📖 Sobre

Nesse projeto foi criado um sistema de simulação de uma conta bancária. Como requisito do projeto, era necessário implementar os módulos conta e pix.

Dentro do módulo conta existem as operações de realizar um depósito, realizar saque e verificar o extrato. Dentro do módulo pix existem as operações de cadastro e remoção de chave pix (do tipo telefone e CPF) e listagem das chaves cadastradas e envio de pix para contatos favoritos cadastrados ou outros, inserindo nome e chave na hora da transação. Ao inserir esses dados, o contato salva na lista de favoritos.

Além dessas funcionalidades, as validações exigidas foram: não aceitar campos vazios e validar máscara de CPF e telefone.

🔒 Importante!

Ao rodar esse projeto no seu computador, as informações inseridas são salvas apenas no banco de dados local. É completamente seguro inserir dados reais ou fictícios no site.

📚 Estudo

Esse projeto é uma aplicação para estudo de desenvolvimento web front-end exigida da disciplina de Programação Web.

🚀 Começando

Por falta de recursos para hospedar um projeto em PHP com banco de dados, é necessário baixar o projeto e rodar na sua máquina para poder visualiza-lo funcionando, para isso, siga os passos a seguir:

Pré-requisitos

• XAMPP (ou ambiente alternativo de desenvolvimento PHP e SQL)

Clonando

Como clonar

git clone https://github.com/brunaciarlo/BeeBank.git

Mover (caso ainda não esteja) a pasta do projeto clonado para dentro da pasta htdocs, no XAMPP

Iniciar Apache e MySQL no XAMPP

Acessar http://localhost/phpmyadmin/ no navegador (ou clicar no botão Admin no XAMPP ao lado do MySQL)

Exportar o arquivo bee_bank.sql que está dentro da pasta db do projeto clonado

Acessar http://localhost/beebank/ no navegador

---

🐝 Bee bank 💵

About • Getting Started

📖 About

In this project it was created a bank account simulation's system. As a project requirement, it was necessary to implement the modules "account" and "pix*".

Within the "account" module, there are operations to make a deposit, withdraw funds, and check the statement. Within the "pix" module, there are operations for registering and removing pix keys (such as phone number and CPF), listing registered keys, and sending pix to registered favorite contacts or others, entering name and key at the time of the transaction. When entering this data, the contact is saved in the favorites list.

In addition to these functionalities, the required validations were: not accepting empty fields and validating CPF and phone number masks.

*PIX is a Brazilian instant payment system introduced by the Central Bank of Brazil. It enables individuals and businesses to make real-time payments 24/7, including weekends and holidays, using various identifiers and it is processed almost instantly.

🔒 Important!

When running this project on your computer, the information entered is only saved in the local database. It is completely safe to enter real or fictitious data on the website.

📚 Study

This project is an apliccation with the purpose of front-end development study for "Web Programming" subject.

🚀 Getting Started

Due to a lack of resources to host a PHP project with a database, it is necessary to download the project and run it on your machine in order to view it in operation. To do this, follow the steps below:

Prerequisites

• XAMPP (or an alternative environment to run PHP and SQL)

Cloning

How to clone

git clone https://github.com/brunaciarlo/BeeBank.git

Move (in case it isn't yet) the project cloned folder into the htdocs directory in XAMPP

Start Apache and MySQL in XAMPP

Access http://localhost/phpmyadmin/ in the browser (or click Admin in XAMPP next to MySql)

Export the file bee_bank.sql which is in db folder, within the cloned project

Access http://localhost/beebank/ in the browser