raldney / crypto-dash

CriptoBoard

Sistema para acompanhamento de preços das Criptos em USD usando API da cryptocompare. A exchange selecionada para acompanhamento foi a Coinbase

1. Pré requisitos de instalação

   Antes de instalar tenha certeza que os pre-requisitos foram atendidos.

2. Clone o projeto

   Clonar o projeto e instalar a partir do Github

3. Rode a aplicação

   By this point we’ll have all the project pieces in place.

4. EndPoints

   Rotas da api

5. Arquitetura

   Estrutura do sistema

Pré requisitos de instalação

Sistema criado para rodar essencialmente em maquinas (Linux/MacOS).

Para iniciar o sistema os seguintes requisitos são obrigatórios.

• Git
• Docker
• Docker Compose

Verifique se o docker-compose já esta instalado usando o seguinte comando:

which docker-compose

Imagens usadas

• Node 16
• Nginx

Aplicação	Porta
Proxy	80
App	8000

---

Clone o projeto

Para instalar o acesse o link Git, após isso baixa e instale a aplicação seguindo as instruções:

git clone [email protected]:raldney/crypto-dash.git

Acesse o diretório:

cd crypto-dash

---

Rode a aplicação

1. Iniciar a aplicação :

   docker-compose up -d --build

   Por favor, aguarde isso pode levar alguns minutos ...

   docker-compose logs -f # Acompanhe os logs

   1. Possíveis problemas:

      Conexão com API CryptoCompare

      1. Verifique se não existe nenhuma outra conexão com a API KEY utilizada
      2. Use alguma VPN para alterar o IP, muitas vezes eles podem ter inserido o IP na BlackList (Meu Caso T.T)

2. Abra seu browser e acesse:

   • http://localhost
   • ou
   • http://localhost:8000

   2.1. Registre-se fornecendo qualquer informação, a única realmente necessária é a API_KEY

3. Selecione as moedas desejadas. PS: algumas delas não estão disponíveis para consulta.

4. Ao terminar, pare e limpe os serviços

   sudo docker-compose down -v

---

Pontos não alcançados

1. Infelizmente não consegui cobrir o sistema com testes automatizados

Possíveis melhorias

API

1. Para uma otimização e confiabilidade das informações pode ser possível realizar a criação de uma API para salvar as informações do usuário, por exemplo: API_KEY e a Watchlist dele. Favorecendo assim a facilidade de uso e consulta das informações da plataforma.

2. Podendo realizar o encapsulamento da conexão com o WebSocket da CryptoCompare, pois da forma atual, a API_KEY esta exposta podendo ser "pega" por pessoas maliciosas.

Gráficos

1. Para uma melhor visualização da ferramenta seria interessante inserir gráficos para realizar um melhor acompanhamento.

Saldo

1. Outro ponto interessante seria cadastrar quanto de cada moeda está sob custódia e assim realizar o cálculo do balanço em tempo real.

Noticias

1. Inserir uma barra lateral mostrando as principais notícias do mundo cripto, seria uma boa ideia para poder tomar decisões mais rapidas.