Skip to content

Commit

Permalink
Merge pull request #98 from fga-eps-mds/doc#88/arquitetura
Browse files Browse the repository at this point in the history
[DOCS] Inicia documento de arquitetura do projeto (#88)
  • Loading branch information
dartmol203 authored Dec 9, 2024
2 parents 1436081 + d6eafee commit 4093da3
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 1 deletion.
44 changes: 44 additions & 0 deletions docs/projeto/arquitetura.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Documentação de Arquitetura

## Versionamento

| **Versão** | **Data** | **Modificação** | **Responsável** |
| :-: | :-: | :-: | :-: |
| 0.1 | 09/12/24 | Criação do documento | Gabriel Mariano |
| 1.0 | 09/12/24 | atualização do documento | André Corrêa |

*Tabela 1: Versionamento*

---

## Objetivo

A documentação de arquitetura visa apresentar uma visão técnica da estutura organizacional do produto de software a ser desenvolvido, apresentando elementos como o *stack* da aplicação, a organização dos serviços, a estrutura da camada de persistência, os *endpoints* definidos e também instruções para a execução do projeto.

## Stack

Foram definidas as seguintes tecnologias para o projeto:

| **Tecnologia** | **Serviço (s)** | **Objetivo** |
| :-: | :-: | :-: |
| *NestJs* | UserService e StudioMaker | Back-End do Sistema |
| *NextJs* | FrontEnd | Front-End do Sistema |
| *Flutter* | APP | Aplicativo Móvel |
| *Swagger* | UserService e StudioMaker | Documentação das Rotas do Back-End |
| *Docker* | UserService, StudioMaker e FrontEnd | Conteinerização da Aplicação |

*Tabela 2: Stack do Sistema*

## Deploy

O *deploy* da aplicação foi realizado na plataforma **Render** e pode ser encontrado [NESSE LINK](https://arandu.onrender.com/).

## Documentação Anterior

Por se tratar de um sistema legado de outra equipe de desenvolvimento, uma documentação prévia da arquitetura do sistema pode ser encontrada na [Documentação de Arquitetura do Projeto Calculus 2024-1](https://fga-eps-mds.github.io/2024.1-CALCULUS-DOC/organizacoes/documento_arquitetura/).

## Atualização dos documentos de arquitetura

Para as pŕoximas etapas, serão realizadas verificações dos atuais documentos e sera atualizado o que for necessário, por exemplo, é necessário a atualização que mostra a ligação do app mobile com os backends.

Além disso, com essa validação, os documentos serão adicionados nesse repositório, retirando a necessidade da ligação com o do semestre anterior
21 changes: 21 additions & 0 deletions docs/projeto/estrutura_analitica.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Estrutura Analítica do Projeto

## Versionamento

| **Versão** | **Data** | **Modificação** | **Responsável** |
| :-: | :-: | :-: | :-: |
| 0.1 | 09/12/24 | Criação do documento | Gabriel Mariano |

*Tabela 1: Versionamento*

---

## Objetivo

A Estrutura Analítica do Projeto (EAP ou *WBS*) visa apresentar de forma direta e simples os componentes entregáveis necessários para a realização do projeto.

## Apresentação

A Estrutura Analítica do Projeto relativa ao ARANDU (2024.2) pode ser encontrada [NESSE LINK](https://miro.com/app/board/uXjVL6Y3LSc=/?share_link_id=864080265943) ou em componente abaixo:

<iframe width="768" height="432" src="https://miro.com/app/embed/uXjVL6Y3LSc=/?pres=1&frameId=3458764609900753204&embedId=642560816832" frameborder="0" scrolling="no" allow="fullscreen; clipboard-read; clipboard-write" allowfullscreen></iframe>
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,16 @@ nav:
- Revisão Técnica, de Negócio e de UX: 'Lean_Inception/rev_tec.md'
- Sequenciador: 'Lean_Inception/sequencia.md'
- Canvas MVP: 'Lean_Inception/canvas_mvp.md'
- Gestão do Projeto:
- Estrutura Analítica do Projeto: 'projeto/estrutura_analitica.md'
- Documento de Arquitetura: 'projeto/arquitetura.md'
# - Documentação Técnica:
# - Termo de Abertura do Projeto: 'organizacoes/tap.md'
# - Documento de Arquitetura: 'organizacoes/documento_arquitetura.md'
# - Estrutura Analítica do Projeto: 'organizacoes/eap.md'
# - Visão de Dados: 'organizacoes/visao-de-dados.md'
# - Visão de Endpoints: 'organizacoes/visao-de-endpoints.md'
# - Manual de Instruções: 'organizacoes/manual_de_instruções.md'
- Gestão do Projeto:
# - Plano de Comunicação: 'planejamento/plano_comunicacao.md'
- Plano de Qualidade: 'projeto/qualidade.md'
- Plano de Custos: 'projeto/custos.md'
Expand Down

0 comments on commit 4093da3

Please sign in to comment.