first commit
This commit is contained in:
43
docs/README.md
Normal file
43
docs/README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# 🐾 PawLink — Documentação do Projecto
|
||||
|
||||
**Plataforma de Adopção e Doação Animal**
|
||||
Prova de Aptidão Profissional (PAP) — Ano Lectivo 2024/2025
|
||||
|
||||
---
|
||||
|
||||
## Índice
|
||||
|
||||
| # | Documento | Conteúdo |
|
||||
|---|---|---|
|
||||
| 01 | [Visão Geral](./01-visao-geral.md) | Problema, solução, público-alvo, proposta de valor, modelo de negócio |
|
||||
| 02 | [Requisitos](./02-requisitos.md) | Requisitos funcionais e não-funcionais, restrições |
|
||||
| 03 | [Arquitectura](./03-arquitectura.md) | Diagrama de arquitectura, camadas, fluxos de dados, decisões técnicas |
|
||||
| 04 | [Base de Dados](./04-base-de-dados.md) | ERD, descrição das entidades, esquema Prisma completo, estratégia de indexação |
|
||||
| 05 | [Fluxos de Utilizador](./05-fluxos-utilizador.md) | User stories, fluxos detalhados de adopção, doação e navegação |
|
||||
| 06 | [Stack Tecnológica](./06-stack-tecnologica.md) | Todas as tecnologias com versões, funções e justificações |
|
||||
| 07 | [Segurança](./07-seguranca.md) | Autenticação, autorização, RGPD, conformidade de pagamentos |
|
||||
| 08 | [Inteligência Artificial](./08-ia.md) | Casos de uso, agente de match, chatbot, system prompts, mecanismos de contexto |
|
||||
| 09 | [Estrutura do Projecto](./09-estrutura-projecto.md) | Árvore de directórios completa, convenções de nomenclatura |
|
||||
| 10 | [Orientações de Desenvolvimento](./10-orientacoes-desenvolvimento.md) | Setup, convenções de código, Git, testes, performance, acessibilidade |
|
||||
| 11 | [Roadmap](./11-roadmap.md) | 4 fases de desenvolvimento com estimativas, KPIs e gestão de riscos |
|
||||
| 12 | [Glossário](./12-glossario.md) | Definição de todos os termos técnicos e acrónimos usados |
|
||||
|
||||
---
|
||||
|
||||
## Resumo Técnico
|
||||
|
||||
| Aspecto | Escolha |
|
||||
|---|---|
|
||||
| **Framework** | Next.js 14+ (App Router, SSR) |
|
||||
| **Linguagem** | TypeScript 5+ |
|
||||
| **Base de Dados** | PostgreSQL via Supabase + Prisma ORM |
|
||||
| **Autenticação** | NextAuth.js com verificação de +18 anos |
|
||||
| **Pagamentos** | Stripe (Cartão + MBWay) |
|
||||
| **Email** | Resend + react-email |
|
||||
| **IA** | Anthropic Claude API (match + chatbot) |
|
||||
| **Hosting** | Vercel + Cloudflare CDN |
|
||||
| **Estilos** | Tailwind CSS + shadcn/ui |
|
||||
|
||||
---
|
||||
|
||||
*Documentação gerada para a PAP 2024/2025*
|
||||
Reference in New Issue
Block a user