gilsonreis / desafio-dev

Desafio programação - Bycoders

Essa é a documentação do sistema feito para teste para Desenvolvedor na ByCoders. Abaixo, segue manual de instação e uso do sistema.

Descrição técnica

Backend

Para desenvolvimento da API foi utilizado PHP 7.4 juntamente com Slim Framework na versão 4. Foi utilizado alguns conceitos de SOLID, como SRP, OCP e ISP.

No banco de dados, foi utilizado MySQL (MariaDB). Utilizei PHP ADODB para abstrair a conexão do banco e fiz um pequeno ORM com Entity Manager para manipular os repositories.

Frontend

No front, foi utilizado ReactJS, HTML e CSS puros. Para manutenção do estado foi utilizado ContextAPI e Hooks.

A comunicação entre API e Front se dá através do padrão REST, utilizando JSEND como padrão do formato de retorno da API.

A autenticação do usuários se dá atráves da troca de token JWT.

Em todo o projeto, foi utilizado a segunda lei de Object Calisthenics, "Don’t Use The ELSE Keyword";

Instalação

A API e o banco de dados estão utilizando Docker.

Primeiro passo, depois de fazer o clone do projeto, é duplicar e renomear o arquivo .env.dist para .env

Após isso, para subir a instância para rodar o seguinte comando no terminal dentro da pasta api.

> docker-compose up

Após o download terminar e as instâncias subir, execute no terminal, ainda na pasta api:

> bin/php

Esse comando irá entrar dentro da instancia do PHP. Após isso, execute os comandos:

> composer install  
> bin/phinx migrate
> bin/phinx seed:run

Assim, irá instalar as dependencias do PHP e irá migrar todas as tabelas e dados necessários para iniciar e testar o projeto.

A API irá subir na porta 8080, em localhost.

Para iniciar o front, acesse a pasta front/spa e execute:

> yarn dev

a aplicação irá subir na porta 3000, em localhost.

Para logar, utilizar os dados abaixo:

username: [e-mail]
password: admin

Documentação da API.

Dentro da pasta ./api/docs existe um arquivo chamado ByCoders.postman_collection.json, que é um arquivo com as rotas utilizadas pelo Postman. Basta importa-lo no Postaman para ter acesso as rotas e parametros da API.

---

Desenvolvido por Gilson Reis - Simplify Softwares

Desafio programação - para vaga desenvolvedor

Por favor leiam este documento do começo ao fim, com muita atenção. O intuito deste teste é avaliar seus conhecimentos técnicos em programação. O teste consiste em parsear este arquivo de texto(CNAB) e salvar suas informações(transações financeiras) em uma base de dados a critério do candidato. Este desafio deve ser feito por você em sua casa. Gaste o tempo que você quiser, porém normalmente você não deve precisar de mais do que algumas horas.

Instruções de entrega do desafio

1. Primeiro, faça um fork deste projeto para sua conta no Github (crie uma se você não possuir).
2. Em seguida, implemente o projeto tal qual descrito abaixo, em seu clone local.
3. Por fim, envie via email o projeto ou o fork/link do projeto para seu contato Bycoders_ com cópia para [e-mail].

Descrição do projeto

Você recebeu um arquivo CNAB com os dados das movimentações finanaceira de várias lojas. Precisamos criar uma maneira para que estes dados sejam importados para um banco de dados.

Sua tarefa é criar uma interface web que aceite upload do arquivo CNAB, normalize os dados e armazene-os em um banco de dados relacional e exiba essas informações em tela.

Sua aplicação web DEVE:

1. Ter uma tela (via um formulário) para fazer o upload do arquivo(pontos extras se não usar um popular CSS Framework )
2. Interpretar ("parsear") o arquivo recebido, normalizar os dados, e salvar corretamente a informação em um banco de dados relacional, se atente as documentações que estão logo abaixo.
3. Exibir uma lista das operações importadas por lojas, e nesta lista deve conter um totalizador do saldo em conta
4. Ser escrita na sua linguagem de programação de preferência
5. Ser simples de configurar e rodar, funcionando em ambiente compatível com Unix (Linux ou Mac OS X). Ela deve utilizar apenas linguagens e bibliotecas livres ou gratuitas.
6. Git com commits atomicos e bem descritos
7. PostgreSQL, MySQL ou SQL Server
8. Ter testes automatizados
9. Docker compose (Pontos extras se utilizar)
10. Readme file descrevendo bem o projeto e seu setup
11. Incluir informação descrevendo como consumir o endpoint da API

Sua aplicação web não precisa:

1. Lidar com autenticação ou autorização (pontos extras se ela fizer, mais pontos extras se a autenticação for feita via OAuth).
2. Ser escrita usando algum framework específico (mas não há nada errado em usá-los também, use o que achar melhor).
3. Documentação da api.(Será um diferencial e pontos extras se fizer)

Documentação do CNAB

Descrição do campo	Inicio	Fim	Tamanho	Comentário
Tipo	1	1	1	Tipo da transação
Data	2	9	8	Data da ocorrência
Valor	10	19	10	Valor da movimentação. Obs. O valor encontrado no arquivo precisa ser divido por cem(valor / 100.00) para normalizá-lo.
CPF	20	30	11	CPF do beneficiário
Cartão	31	42	12	Cartão utilizado na transação
Hora	43	48	6	Hora da ocorrência atendendo ao fuso de UTC-3
Dono da loja	49	62	14	Nome do representante da loja
Nome loja	63	81	19	Nome da loja

Documentação sobre os tipos das transações

Tipo	Descrição	Natureza	Sinal
1	Débito	Entrada	+
2	Boleto	Saída	-
3	Financiamento	Saída	-
4	Crédito	Entrada	+
5	Recebimento Empréstimo	Entrada	+
6	Vendas	Entrada	+
7	Recebimento TED	Entrada	+
8	Recebimento DOC	Entrada	+
9	Aluguel	Saída	-

Avaliação

Seu projeto será avaliado de acordo com os seguintes critérios.

1. Sua aplicação preenche os requerimentos básicos?
2. Você documentou a maneira de configurar o ambiente e rodar sua aplicação?
3. Você seguiu as instruções de envio do desafio?
4. Qualidade e cobertura dos testes unitários.

Adicionalmente, tentaremos verificar a sua familiarização com as bibliotecas padrões (standard libs), bem como sua experiência com programação orientada a objetos a partir da estrutura de seu projeto.

Referência

Este desafio foi baseado neste outro desafio: https://github.com/lschallenges/data-engineering

---

Boa sorte!