From 9bd172e9c2376508876ba562096d74c937c79ebd Mon Sep 17 00:00:00 2001 From: angelicaccampos Date: Sat, 7 Dec 2024 09:43:57 -0300 Subject: [PATCH] =?UTF-8?q?docs(README):=20Adiciona=20especifica=C3=A7?= =?UTF-8?q?=C3=B5es=20das=20ferramentas=20frontend?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- frontend/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 frontend/README.md diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 00000000..18dc4eaf --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,42 @@ +# Projeto Vite + TypeScript + Tailwind CSS + +Este projeto utiliza [Vite](https://vitejs.dev/) para o build, [TypeScript](https://www.typescriptlang.org/) como linguagem principal, e [Tailwind CSS](https://tailwindcss.com/), [Material Ui](https://mui.com/material-ui/getting-started/installation/), [mambaui](https://mambaui.com/components/table), [daisyui](https://daisyui.com/components/table/) e [shadcn/ui](https://ui.shadcn.com/) para o design. + +## Requisitos + +Certifique-se de ter as seguintes ferramentas instaladas: + +- [Node.js](https://nodejs.org/) (versão 14.18+) +- [npm](https://www.npmjs.com/) ou [yarn](https://yarnpkg.com/) + +## Instalação + +Entre na pasta [brb](/frontend/brb/) + +instale as depedências com: + +```bash + npm install +``` + +## Executando o projeto + +Para rodar a aplicação + +```bash + npm run dev +``` + +## Estrutura das pastas: + +- src/: Contém o código-fonte do projeto. + + - App.tsx: Arquivo principal. + - index.css: Configuração do Tailwind. + - components: Pasta destinada aos componentes. + - types: Pasta destinada aos tipos do Ts. + - utils: Pasta destinada a funções como de validação. + +- tailwind.config.js: Arquivo de configuração do Tailwind CSS. +- postcss.config.js: Arquivo de configuração do Post CSS. +- vite.config.ts: Arquivo de configuração do Vite.