Aplicação front-end construída com React + Vite para gerenciamento de passeios.
Este repositório contém a UI (Vite + React) usada para gerenciar passeios, com integração a APIs via Axios e estilos com Bootstrap.
- React
- Vite
- Axios
- Bootstrap
- Node.js >= 16
- npm ou yarn
-
Instale dependências:
npm install
-
Inicie em modo desenvolvimento:
npm run dev
npm run dev— inicia o servidor de desenvolvimento (Vite)npm run build— gera build de produçãonpm run preview— pré-visualiza o build de produçãonpm run lint— executa o ESLint configuradonpm run docs— gera a documentação JSDoc em./docs(requerjsdoccomo devDependency)npm run typecheck— executatsc --noEmitpara verificação de tipos TypeScript
Este projeto usa JSDoc para comentários de código (seguindo o padrão Google/JSDoc para JavaScript/JSX). A configuração de geração está em jsdoc.json e a saída é escrita em ./docs.
Gerar documentação localmente:
-
Instale a dependência de desenvolvimento (se ainda não instalou):
npm install --save-dev jsdoc
-
Gere a documentação:
npm run docs
- Use comentários JSDoc em módulos, funções e componentes React.
- Inclua
@parame@returnsquando aplicável, e uma breve descrição em português. - Exemplos de uso e tipos com
import('axios').AxiosInstancesão bem-vindos para tipagem nos comentários.
Veja CONTRIBUTING.md para orientações sobre estilo, commits e pull-requests.
Este projeto é licenciado sob a licença MIT — consulte o arquivo LICENSE.