Skip to content

About

A web admin app for creating, editing and managing school field trips (schedules, pricing, participants, images). Built with React and Vite, it uses Bootstrap for UI and Axios for API calls; it includes Vitest tests and JSDoc docs and is undergoing an incremental migration to TypeScript with ESLint/Prettier, Husky, and CI configured

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

FiebPasseios

Aplicação front-end construída com React + Vite para gerenciamento de passeios.

Visão geral

Este repositório contém a UI (Vite + React) usada para gerenciar passeios, com integração a APIs via Axios e estilos com Bootstrap.

Principais tecnologias

  • React
  • Vite
  • Axios
  • Bootstrap

Pré-requisitos

  • Node.js >= 16
  • npm ou yarn

Instalação e execução

  1. Instale dependências:

    npm install

  2. Inicie em modo desenvolvimento:

    npm run dev

Scripts úteis

  • npm run dev — inicia o servidor de desenvolvimento (Vite)
  • npm run build — gera build de produção
  • npm run preview — pré-visualiza o build de produção
  • npm run lint — executa o ESLint configurado
  • npm run docs — gera a documentação JSDoc em ./docs (requer jsdoc como devDependency)
  • npm run typecheck — executa tsc --noEmit para verificação de tipos TypeScript

Documentação (JSDoc)

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:

  1. Instale a dependência de desenvolvimento (se ainda não instalou):

    npm install --save-dev jsdoc

  2. Gere a documentação:

    npm run docs

Padrões de documentação

  • Use comentários JSDoc em módulos, funções e componentes React.
  • Inclua @param e @returns quando aplicável, e uma breve descrição em português.
  • Exemplos de uso e tipos com import('axios').AxiosInstance são bem-vindos para tipagem nos comentários.

Contribuindo

Veja CONTRIBUTING.md para orientações sobre estilo, commits e pull-requests.

Licença

Este projeto é licenciado sob a licença MIT — consulte o arquivo LICENSE.

About

A web admin app for creating, editing and managing school field trips (schedules, pricing, participants, images). Built with React and Vite, it uses Bootstrap for UI and Axios for API calls; it includes Vitest tests and JSDoc docs and is undergoing an incremental migration to TypeScript with ESLint/Prettier, Husky, and CI configured

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages