O projeto é um conversor de moedas, para isso foi criado uma API capaz de realizar a conversão, criação, atualização, exclusão e listagem de moedas. Além disso foi criado um FrontEnd que permite de forma intuitiva a utilização das funções básica da API.
O sistema possui um serviço de atualização de 5 em 5 minutos (podendo ser alterado no index.js da API) das moedas cadastradas. Esse serviço é possível graças a uma API externa e aberta que fornece informações atualizadas de diversas moedas. A API externa pode ser acessada aqui.
É importante ressaltar que o valor base utilizado para conversão foi o Dólar Americano (lastro), então para inclusão e atualização de uma nova moeda, seu valor deve ser baseado no valor de 1 dólar. Exemplo: Para adicionar a moeda Euro, deve informar o valor de x Euros equivalente a 1 dólar.
A arquitetura utilizada foi um monolito que utiliza as seguintes tecnologias: MongoDB - NodeJs (JavaScript) - VueJs (Framework JavaScript).
O projeto foi colocado em um contâiner Docker, porém só foi testado no Docker Playground devido as dificuldades encontradas causada pela incompatibilidade entre o Docker e a versão do meu Windows (Windows Home).
Foi utilizado utilizado o framework VueJs no frontend e para inicialização do projeto foi utilizado seu CLI.
É necessário a instalação do NodeJs 12.X, MongoDB e GIT para inicialização do projeto.
- Instalação do NodeJs: Acesse aqui e realize o download do NodeJs 12.X
- Instalação do MongoDB: Realize o download do instalador aqui.
- Instalação do GIT: Realize o download aqui e realize a instalção.
Obs.: Não é necessário a instalação caso utilize o Docker. Para instalção do Docker, acesse aqui
Realizado as configurações vamos para a próxima etapa.
Acesse o repositório do meu desafio
Execute o comando
git clone https://github.com/lmaiaa/challenge-bravo.git
- Com Docker:
Acesse a pasta clonada e inicialize o projeto com o seguinte comando:
docker-composer up -d
- Sem Docker:
Acesse a pasta clonada e instale as dependências
cd challenge-bravo
npm install
Após isso o projeto está pronto para ser inicializado. Para inicializar execute o comando:
npm start
Ao inicializar o projeto:
- API pode ser acessada em: http://localhost:3333
- Client (Frontend) pode ser acessado em: http://localhost:8080
A API está por padrão sendo executada na URL:
-
GET /coins -> Retorna uma lista de moedas cadastras na API
-
GET coin/conversion?from=Moeda1&to=Moeda2&amount=Valor -> Realiza a conversão entre moedas cadastradas
-
POST /coin -> Cria uma nova moeda
-
PUT /coin/:name/:value -> Edita uma moeda (lastro dólar americano)
-
DELETE /coin/:name -> Exclui uma moeda
Para mais informações acesse: http://localhost:3333/api-docs