---

Documentação da Aplicação

Clonando o Repositório

Primeiro, você precisa clonar o repositório do GitHub para a sua máquina local. Abra o terminal e execute o seguinte comando:

git clone https://github.com/luismede/crud-customers.git

---

Instalando Dependências

A aplicação utiliza um arquivo requirements.txt para listar as dependências. Para instalá-las, siga os passos abaixo:

1. Certifique-se de que você tem o Python 3.8+ e o pip instalados.

2. Crie um ambiente virtual (opcional, mas recomendado):

   python -m venv .venv

3. Ative o ambiente virtual:

   • No Windows:

     .venv\Scripts\activate

   • No Linux/MacOS:

     source .venv/bin/activate

4. Instale as dependências listadas no requirements.txt:

   pip install -r requirements.txt

---

Configurando o Banco de Dados MySQL

A aplicação requer um banco de dados MySQL para armazenar os clientes. Siga os passos abaixo para configurar o banco de dados:

1. Instale o MySQL:

   Se o MySQL não estiver instalado na sua máquina, siga as instruções de instalação para o seu sistema operacional aqui.

2. Acesse o MySQL:

   Use o seguinte comando para acessar o MySQL com seu usuário root (ou qualquer outro usuário com permissões adequadas):

   mysql -u root -p

3. Crie o banco de dados:

   Crie um banco de dados para a aplicação (substitua table_clients pelo nome desejado):

   CREATE DATABASE table_clients;

4. Selecione o banco de dados:

   USE table_clients;

5. Crie a tabela customers:

   Agora, crie a tabela customers com três colunas: id, name e cpf:

   CREATE TABLE customers (
       id INT AUTO_INCREMENT PRIMARY KEY,
       name VARCHAR(255) NOT NULL,
       cpf VARCHAR(11) NOT NULL,
       number_phone VARCHAR(15) NOT NULL,
       cep VARCHAR(9) NOT NULL,
       address VARCHAR(100) NOT NULL,
       city VARCHAR(100) NOT NULL,
       uf VARCHAR(3) NOT NULL
      
   );

   Essa tabela possui uma coluna id que é a chave primária e auto-incrementada, uma coluna name para o nome do cliente, e uma coluna cpf para o CPF (formato brasileiro, 11 caracteres), uma coluna number_phone para o telefone do cliente, uma coluna ceppara o CEP do cliente, addres para o lologradouro do cliente, uma coluna city para a cidade em que o cliente mora e uma coluna uf para a UF do cliente.

---

Executando a Aplicação

1. Certifique-se de que o banco de dados MySQL está rodando e que a tabela customers foi criada corretamente.

2. Edite as configurações de conexão com o banco de dados no código da aplicação, se necessário. Abra o arquivo onde a conexão MySQL(db.connection.py) está configurada e ajuste as credenciais:

   engine = create_engine('mysql+pymysql://root:passw0rd@localhost/table_clients')

   Substitua root e passw0rd pelas suas credenciais de banco de dados, e table_clients pelo nome do banco de dados que você criou.

3. Execute o script Python:

   python app.py

---

Requisitos

• Python 3.8 ou superior
• MySQL
• Bibliotecas listadas no requirements.txt

---

Contribuições

Sinta-se à vontade para fazer contribuições! Basta abrir uma issue ou enviar um pull request.