Skip to content

Commit

Permalink
docs(README): Adiciona especificações das ferramentas frontend
Browse files Browse the repository at this point in the history
  • Loading branch information
angelicaccampos committed Dec 7, 2024
1 parent 5208bb4 commit 9bd172e
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 9bd172e

Please sign in to comment.