Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bush1d3v/nei_market_front

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.
https://github.com/bush1d3v/nei_market_front

actions biomejs bun cypress devcontainer docker i18next javascript mitt nodejs pinia playwright postcss shadcn-vue storybook tailwindcss typescript vitest vue vueuse

Last synced: about 14 hours ago
JSON representation

Host: GitHub
URL: https://github.com/bush1d3v/nei_market_front
Owner: bush1D3v
License: mit
Created: 2024-09-09T13:57:29.000Z (4 months ago)
Default Branch: dev
Last Pushed: 2024-12-27T02:14:38.000Z (2 days ago)
Last Synced: 2024-12-27T03:19:46.470Z (2 days ago)
Topics: actions, biomejs, bun, cypress, devcontainer, docker, i18next, javascript, mitt, nodejs, pinia, playwright, postcss, shadcn-vue, storybook, tailwindcss, typescript, vitest, vue, vueuse
Language: Vue
Homepage:
Size: 2 MB
Stars: 7
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

PT-BR 🇧🇷

# 📊 Nei Market Analytics

![License](https://img.shields.io/static/v1?label=license&message=MIT&color=orange)
![Bun version](https://img.shields.io/static/v1?label=bun&message=v1.1.24&color=yellow)
![Repository size](https://img.shields.io/github/repo-size/bush1D3v/nei_market_front?color=blue)
![Pull request](https://img.shields.io/static/v1?label=PR&message=welcome&color=green)

## 🔍 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 os containers de navarro_blog_front
`docker-up`: Sobe os contêineres navarro_blog_front
`docker-clean`: Remove as imagens docker do projeto

## Configuração IDE recomendada

Procure no arquivo [extensions.json](https://github.com/bush1D3v/NEI_market_analytics/blob/main/.vscode/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](https://marketplace.visualstudio.com/items?itemName=Vue.volar) para tornar o serviço de linguagem TypeScript ciente dos tipos `.vue`.

## Configuração do projeto

```sh
bun install
```

### Compilar e recarregar rapidamente para Front-end

```sh
bun dev
```

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

```sh
bun build
```

### Executar testes de unidade com [Vitest](https://vitest.dev/)

```sh
bun test:unit
```

### Executar testes de ponta a ponta com [Playwright](https://playwright.dev/)

```sh
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`: Runs the navarro_blog_front containers
`docker-up`: Builds and up the navarro_blog_front containers
`docker-clean `: Remove docker images

## Recommended IDE Setup

Search the [extensions.json](https://github.com/bush1D3v/NEI_market_analytics/blob/main/.vscode/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](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.

## Project Setup

```sh
bun install
```

### Compile and Hot-Reload for Front-end

```sh
bun dev
```

### Type-Check, Compile and Minify for Production

```sh
bun build
```

### Run Unit Tests with [Vitest](https://vitest.dev/)

```sh
bun test:unit
```

### Run E2E Tests with [Playwright](https://playwright.dev/)

```sh
bun test:e2e
```