From 3bb2d11e2ac16c23bccf5236c4fe91234afc6331 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Victor=20Jos=C3=A9=20Lopes=20Navarro?= Date: Mon, 9 Sep 2024 12:06:59 -0300 Subject: [PATCH] docs: Update README.md --- README.md | 147 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 140 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index edd3f93..8886689 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,152 @@ -# nei-market-analytics +PT-BR 🇧🇷 -This template should help get you started developing with Vue 3 in Vite. +# 📊 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_analytics?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 +
+ vuejs  + shadcnvue    + pinia  + mitt  + bunjs + nodejs + tailwindcss + typescript + postcss  + dotenv    + github actions    + docker   + vitest    + storybook-js     + vueuse   + biomejs   + chromatic   +
+ +## 🏗 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 desenvolvimento + +```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 [Cypress](https://www.cypress.io/) + +```sh +bun test:e2e:dev +``` + +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. + +Mas ainda é recomendado testar a compilação de produção com `test:e2e` antes de implantar (por exemplo, em ambientes de CI): + +```sh +bun build +bun test:e2e +``` + +ENG 🇺🇸 + +# 📊 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_analytics?color=blue)   +![Pull request](https://img.shields.io/static/v1?label=PR&message=welcome&color=green) + +## 🔍 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 + +
+ vuejs   + shadcnvue     + pinia   + mitt  + bunjs + nodejs  + tailwindcss  + typescript   + postcss  + dotenv   + github actions   + docker   + vitest    + storybook-js     + vueuse   + biomejs   + chromatic   +
+ +## 🏗 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 -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). +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. -## Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - ## Project Setup ```sh