PT-BR 🇧🇷

📊 Nei Market Analytics

     

🔍 Sobre o Projeto

O NEI Market Analytics é um projeto de código aberto projetado para fornecer análises abrangentes de valor de mercado para vários instrumentos financeiros e ativos digitais. Este repositório visa criar uma plataforma robusta para rastrear e analisar tendências de mercado em vários setores.

🛠️ Tecnologias e Ferramentas Utilizadas

                                       

🏗 Estrutura e Arquitetura

O projeto segue os princípios da arquitetura limpa, e o código foi organizado de acordo com os princípios de modularidade, reutilização e responsabilidade única.

🐳 Docker

Com a adição do Docker, você agora pode utilizar dos scripts fornecidos em package.json para poder construir a imagem docker e rodar o container da aplicação.

Para isso, segue a lista de funções de cada script:

docker-build: Constrói as imagens docker do projeto
docker-run: Roda e sobe o container nei_market_front

Configuração IDE recomendada

Procure no arquivo extensions.json as recomendações e instale-as no seu VSCode.

Suporte de tipo para importações .vue em TS

O TypeScript não pode manipular informações de tipo para importações .vue por padrão, então substituímos o CLI tsc por vue-tsc para verificação de tipo. Em editores, precisamos de Volar para tornar o serviço de linguagem TypeScript ciente dos tipos .vue.

Configuração do projeto

bun install

Compilar e recarregar rapidamente para Front-end

bun dev

Verificação de tipo, compilação e minimização para produção

bun build

Executar testes de unidade com Vitest

bun test:unit

Executar testes de ponta a ponta com Playwright

bun test:e2e

Isso executa os testes de ponta a ponta no servidor de desenvolvimento Vite. É muito mais rápido do que a compilação de produção.

ENG 🇺🇸

📊 Nei Market Analytics

     

🔍 About the Project

The NEI Market Analytics is an open-source project designed to provide comprehensive market value analyses for various financial instruments and digital assets. This repository aims to create a robust platform for tracking and analyzing market trends across multiple sectors.

🛠️ Technologies and Tools Used

                                       

🏗 Structure and Architecture

The project follows the principles of clean architecture, and the code was organized according to the principles of modularity, reusability and single responsibility.

🐳 Docker

With the addition of Docker, you can now use the scripts provided in package.json to build the docker image and run the application container.

To do this, here is the list of functions for each script:

docker-build: Builds the project's docker images
docker-run: Builds and Runs the nei_market_front container

Recommended IDE Setup

Search the extensions.json file as per recommendations and install them in your VSCode.

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need Volar to make the TypeScript language service aware of .vue types.

Project Setup

bun install

Compile and Hot-Reload for Front-end

bun dev

Type-Check, Compile and Minify for Production

bun build

Run Unit Tests with Vitest

bun test:unit

Run E2E Tests with Playwright

bun test:e2e