Skip to content

Commit

Permalink
Merge pull request #1 from FGA0138-MDS-Ajax/layoutReadmeGitPages
Browse files Browse the repository at this point in the history
docs: Layout Inicial do readme e da gitpages
  • Loading branch information
FelipeFreire-gf authored Nov 25, 2024
2 parents 11d4cc4 + 1ffbbdf commit 779bcb6
Show file tree
Hide file tree
Showing 7 changed files with 71 additions and 107 deletions.
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,23 @@

# Sobre

O projeto consiste no desenvolvimento de um sistema para a equipe de competição Mamutes do Cerrado UnB - FCTE que têm como objetivo criar uma aplicação web que sirva para divulgação e também para o gerenciamento da equipe na qual, nesse primeiro momento, somente membros da equipe poderão ter acesso. Dessa forma, teremos os seguintes módulos de desenvolvimento.
Este projeto visa o desenvolvimento de um aplicativo web, concebido para atender às necessidades da equipe de competição Mamutes do Cerrado da UnB - FCTE. A proposta é oferecer uma plataforma unificada que atenda dois pilares principais: divulgação da equipe e gerenciamento interno, otimizando a organização e a visibilidade da equipe.

# Principais Recursos
## Objetivos do Sistema

- Divulgação: página com intuito de apresentar a identidade visual da equipe, seus integrantes, competições e informações essenciais para o processo seletivo.
1. Divulgação da Equipe

- Gerência de calendário: página para gerenciar quadro Kanban de tarefas da equipe, e, também um calendário disponível para compromissos.
Uma página inicial que apresente a identidade visual dos Mamutes do Cerrado, seus integrantes, competições e informações essenciais, como o processo seletivo para novos membros. Essa área será o ponto de entrada, projetada para atrair e engajar visitantes.

- Gerência de estoque: página para controlar as peças, com suas respectivas quantidades e status.
2. Gerenciamento Interno

- Gerência de reuniões: página para adicionar atas e ter o controle de presença de reuniões.
Oferecer ferramentas dedicadas para a organização eficiente das atividades da equipe, distribuídas em módulos específicos:

- Gerência de documentos: página para administração de documentos linkadode voos e correlatos.

- Gerência de Financeiro: página para controle de entradas e saídas com suas respectivas descrições. Além do cálculo final com o saldo atualizado.
- Gerência de Calendário: Uma interface com quadro Kanban para organização de tarefas e um calendário que consolida os compromissos da equipe.
- Gerência de Estoque: Controle detalhado de peças e materiais, incluindo quantidades disponíveis e status atualizado.
- Gerência de Reuniões: Registro de atas e controle de presença nas reuniões, promovendo transparência e acompanhamento das decisões.
- Gerência de Documentos: Administração centralizada de arquivos relacionados à equipe, como documentos de voo e outros correlatos.
- Gerência Financeira: Controle de entradas e saídas financeiras, com registro de descrições e saldo atualizado, garantindo maior controle e planejamento.

# Documentação

Expand Down Expand Up @@ -48,30 +50,30 @@ Link para a documentação do projeto: [MkDocs - Aries 2024.2](https://fga0138-m
Conheça a contribuição dos membros em cada uma das nossas áreas abaixo:


| **📸** | [<img src="https://avatars.githubusercontent.com/u/134105981?v=4" width=100>]() |
| **📸** | [<img src="./docs/view/img/klei.jpg" width=100>]() |
|:---------:|:------------------------------------------------------------------------------: |
| **Nome** | [Caio Duarte](https://github.com/caioduart3) |
| **Nome** | [Klei Nacarat](https://github.com/caioduart3) |
| **Cargo** | Product Owner |

<br></br>


| **📸** | [<img src="https://avatars.githubusercontent.com/" width=100>]() |
| **📸** | [<img src="https://avatars.githubusercontent.com/u/134105981?v=4" width=100>]() |
|:---------:|:------------------------------------------------------------------------------: |
| **Nome** | [nome](https://github.com/caioduart3) |
| **Nome** | [Caio Duarte](https://github.com/caioduart3) |
| **Cargo** | Scrum Master |

<br></br>


| **📸** | [<img src="https://avatars.githubusercontent.com/" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/62055315?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() |
|:---------:|:------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------:|:------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|
| **Nome** | [nome](https://github.com/) | [nome](https://github.com/) | [Felipe Freire](https://github.com/FelipeFreire-gf) | [nome](https://github.com/) | [nome](https://github.com/) | [nome](https://github.com/5) |
| **Cargo** | Leader Squad - Front End | Leader Squad - Back End | Leader Squad - Banco de Dados | Leader Squad - Testes e Deploy | Leader Squad - Add | Leader Squad - Add |
| **📸** | [<img src="https://avatars.githubusercontent.com/u/91512745?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/179030119?" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/62055315?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() |
|:---------:|:------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------:|
| **Nome** | [Ludmila Aysha](https://github.com/ludmilaaysha) | [Rafael Welz](https://github.com/) | [Felipe Freire](https://github.com/FelipeFreire-gf) | [nome](https://github.com/) | [nome](https://github.com/) | [nome](https://github.com/5) |
| **Cargo** | Leader Squad - Front End | Leader Squad - Back End | Leader Squad - Banco de Dados | Leader Squad - Testes e Deploy |

<br></br>

| **📸** | [<img src="https://avatars.githubusercontent.com/" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() | [<img src="https://avatars.githubusercontent.com/" width=100>]() |
| **📸** | [<img src="https://avatars.githubusercontent.com/u/128251768?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/173021374?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/144369305?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/179030119?" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/69173517?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/145882190?v=4" width=100>]() |
|:---------:|:------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------:|:------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|
| **Nome** | [nome](https://github.com/) | [nome](https://github.com/) | [nome](https://github.com/) | [nome](https://github.com/) | [nome](https://github.com/) | [nome](https://github.com/) |
| **Cargo** | DEV | DEV | DEV | DEV | DEV | DEV |
| **Nome** | [Amanda Cruz](https://github.com/) | [Felipe Duarte](https://github.com/) | [Mayara Marques](https://github.com/maymarquee) | [Othavio Araujo](https://github.com/) | [Vinicíus Alves](https://github.com/) | [Izaque Camargos](https://github.com/) |
| **Cargo** | DEV | DEV | DEV | DEV | DEV | DEV |
3 changes: 3 additions & 0 deletions docs/atas-reuniao/cliente/ata-reuniao-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
| Versão | Data | Descrição da Alteração | Nome(s) Integrante(s) |
| :----: | :--: | :--------------------: | :-------------------: |
| 1.0 | 25/02/2024 | Mudei isso e aquilo | Fulano de Tal |
3 changes: 3 additions & 0 deletions docs/atas-reuniao/equipe/ata-reuniao-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
| Versão | Data | Descrição da Alteração | Nome(s) Integrante(s) |
| :----: | :--: | :--------------------: | :-------------------: |
| 1.0 | 25/02/2024 | Mudei isso e aquilo | Fulano de Tal |
93 changes: 15 additions & 78 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,97 +1,34 @@
# Projeto Mamutes Do Cerrado

<p align="center">
<img src="./view/img/logoMamutes.PNG" height='300px' style={{ display: 'block', margin: 'auto', marginTop: '100px' }} />
</p>

<style>
p{
text-indent: 40px;
}
</style>
# Apresentação do projeto

## Apresentação do projeto
<div style="text-align: justify;">
<p>
Projeto de desenvolvimento de software elaborado como parte da disciplina "Métodos e Desenvolvimento de Software" – 2024.2, ministrada pelo professor Ricardo Ajax. O projeto é desenvolvido pela equipe aries e tem como objetivo criar uma plataforma web chamada. Esta plataforma visa integrar e otimizar o gerenciamento e a divulgação das atividades da equipe de competição Mamutes do Cerrado, concentrada na Faculdade de Ciência, Tecnologia e Engenharia da Universidade de Brasília - FCTE, UnB.
</p>
<p>
Na parte de gerenciamento, a qual somente membros da equipe de competição terão acesso com base nos seus cargos, será fornecidos espaços para administrar atas e presença em reuniões, cronograma, documentos, controle financeiro e de estoque.
</p>
<p>
Já no que tange a divulgação, o objetivo do produto é promover a exposição da equipe, bem como competições, eventos e espaço para conhecer a equipe (apresentação). Este projeto acadêmico utiliza metodologias ágeis, especificamente Scrum e XP, para garantir a qualidade e a eficácia do processo de desenvolvimento.
Projeto de desenvolvimento de software elaborado como parte da disciplina "Métodos e Desenvolvimento de Software 2024.2", ministrada pelo professor Ricardo Ajax. O sistema é desenvolvido pela equipe Aries e tem como objetivo criar uma plataforma web que visa integrar e otimizar o gerenciamento e a divulgação das atividades da equipe de competição Mamutes do Cerrado, concentrada na Faculdade de Ciência, Tecnologia e Engenharia da Universidade de Brasília - FCTE, UnB.
</p>
</div>

## Integrantes
<div style="text-align: justify;">
<p>
Encontra-se aqui a equipe por trás desse projeto de software. Dividida nos seguintes cargos:
</p>
</div>

#### Scrum Master
<div style="text-align: justify;">
<p>
O Scrum Master é responsável por gerenciar a metodoligia ágil e garantir que a equipe siga os princípios do Scrum. Esta função envolve a coordenação das sprints. O Scrum Master promove a colaboração e a comunicação eficaz dentro da equipe, sendo essencial para o sucesso.
</p>
</div>
* Integrante: nome

#### Product Owner
<div style="text-align: justify;">
<p>
O Product Owner atua como a ponte entre as necessidades do cliente e a equipe de desenvolvimento. Responsável por definir a visão do produto, priorizar o backlog e garantir que cada funcionalidade seja entregue, revisada e testada, para agregar valor aos usuários finais.
</p>
</div>
* Integrantes: Caio Duarte.

#### Desenvolvedores Front-End
<div style="text-align: justify;">
<p>
Os Desenvolvedores Front-End são responsáveis por criar e prototipar interfaces de usuário intuitivas e esteticamente agradáveis. Levando em consideração o design e a atenção aos detalhes. Garantindo assim, experiências e interações de usuário agradáveis, fornecendo layouts que proporcionam uma fácil utilização e navegação.
</p>
</div>
* Integrantes: nomes.

#### Desenvolvedores Back-End
<div style="text-align: justify;">
<p>
Os Desenvolvedores Back-End são responsáveis pelo resolução de problemas complexos. Os mesmos, constroem sistemas robustos e escaláveis, focando na lógica de servidor e integração de APIs. Garantindo assim, não só a contribuição eficaz em diversas etapas do projeto.
</p>
</div>
* Integrantes: nomes.

#### Administradores de Banco de Dados
<div style="text-align: justify;">
<p>
Administradores de Banco de Dados (DBAs) são responsáveis pela criação, gestão, manutenção e segurança de bancos de dados do projeto. Garantindo que as funcionalidades solicitadas estejam disponíveis e robustas o suficiente para implementações de tecnologias futuras.
</p>
</div>
* Integrantes: Felipe Freire, Felipe Duarte.

#### Desenvolvedores Testes e Deploy
<div style="text-align: justify;">
<p>
Os Desenvolvedores especializados em testes e deploy desempenham funções essenciais no ciclo de vida do desenvolvimento de software, focando na qualidade, integridade e estabilidade dos sistemas. Eles colaboram para garantir que o software esteja funcionando corretamente antes e depois de ser disponibilizado aos usuários, minimizando falhas e melhorando a experiência do cliente final.
</p>
</div>
* Integrantes: nomes.

<br></br>

<table>
<tr>
<td align="center"><a href="https://github.com/caioduart3"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/134105981?v=4" width="200px;" alt=""/><br /><sub><b>Caio Duarte</b></sub></a><br />

<tr>
<td align="center"><a href="https://github.com/caioduart3"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/134105981?v=4" width="200px;" alt=""/><br /><sub><b>Caio Duarte</b></sub></a><br />
<td align="center"><a href="https://github.com/FelipeFreire-gf"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/62055315?v=4" width="200px;" alt=""/><br /><sub><b>Felipe Freire</b></sub></a><br />
<td align="center"><a href="https://github.com/mandicrz"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/128251768?v=4" width="200px;" alt=""/><br /><sub><b>Amanda Cruz</b></sub></a><br />
<td align="center"><a href="https://github.com/felipej3ds"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/173021374?v=4" width="200px;" alt=""/><br /><sub><b>Felipe Duarte</b></sub></a><br />
<td align="center"><a href="https://github.com/isaqzin"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/145882190?v=4" width="200px;" alt=""/><br /><sub><b>Isaque Camargos</b></sub></a><br />
</tr>
<tr>
<td align="center"><a href="https://github.com/ludmilaaysha"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/91512745?v=4" width="200px;" alt=""/><br /><sub><b>Ludmila Aysha</b></sub></a><br />
<td align="center"><a href="https://github.com/maymarquee"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/144369305?v=4" width="200px;" alt=""/><br /><sub><b>Mayara Marques</b></sub></a><br />
<td align="center"><a href="https://github.com/bolzanMGB"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/149620306?v=4" width="200px;" alt=""/><br /><sub><b>Othavio Araujo</b></sub></a><br />
<td align="center"><a href="https://github.com/RafaelSchadt"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/179030119?" width="200px;" alt=""/><br /><sub><b>Rafael Welz</b></sub></a><br />
<td align="center"><a href="https://github.com/bolzanMGB"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/69173517?v=4" width="200px;" alt=""/><br /><sub><b>Vinicíus Alves</b></sub></a><br />
</tr>
<tr>
<td align="center"><a href=""><img style="border-radius: 60%;" src="" width="200px;" alt=""/><br /><sub><b></b></sub></a><br />
<td align="center"><a href="https://github.com/bolzanMGB"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/69173517?v=4" width="200px;" alt=""/><br /><sub><b>Vinicíus Alves</b></sub></a><br />
<td align="center"><a href="https://github.com/isaqzin"><img style="border-radius: 60%;" src="https://avatars.githubusercontent.com/u/145882190?v=4" width="200px;" alt=""/><br /><sub><b>Isaque Camargos</b></sub></a><br />
<td align="center"><a href=""><img style="border-radius: 60%;" src="" width="200px;" alt=""/><br /><sub><b></b></sub></a><br />
</tr>

</table>
</div>

Binary file added docs/view/img/klei.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/view/img/logoMamutes.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 28 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
site_name: Projeto Mamutes do Cerrado
site_name: Documentação Mamutes do Cerrado

nav:
- Apresentação: "index.md"
- Documento de Visão: "documento-visao/documento-visao.md"
- Documento de Requisitos: "documento-requisitos/documento-requisitos.md"
- Documento de Arquitetura: "documento-arquitetura/documento-arquitetura.md"
- Documento de Plano de Testes: "documento-plano-testes/documento-plano-testes.md"
- Atas de Reunião:
- Ata 1: "atas-reuniao/ata-reuniao-1.md"
- Apresentação: index.md

- Atas de reuniao:
- Cliente:
- Ata 1: "atas-reuniao/cliente/ata-reuniao-1.md"

- Equipe:
- Ata 1: "atas-reuniao/equipe/ata-reuniao-1-equipe.md"

- Documentação de Visão: "documento-visao/documento-visao.md"
- Documentação de Requisitos: "documento-requisitos/documento-requisitos.md"
- Documentação de Arquitetura: "documento-arquitetura/documento-arquitetura.md"
- Documentação do Plano de Testes: "documento-plano-testes/documento-plano-testes.md"

theme:
name: material
name: material
features:
- content.code.annotate
- content.tabs.link
- header.autohide
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
language: pt

styles_css:
- view/css/styles.css

0 comments on commit 779bcb6

Please sign in to comment.