Skip to content

Commit

Permalink
[DOCS] Página index com a apresentação do projeto
Browse files Browse the repository at this point in the history
  • Loading branch information
JAugustoM committed Dec 9, 2024
1 parent bd77fc5 commit 045ff42
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 13 deletions.
Binary file added docs/catavento.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
104 changes: 92 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,97 @@
# Welcome to MkDocs
# 2024/2 - RUNA FEHU
<p align="center">
<img src="./catavento.jpeg" height='350px'>
</p>

For full documentation visit [mkdocs.org](https://www.mkdocs.org).
# Sobre
A empresa Catavento, cliente da equipe Fehu, é especializada na manufatura e comercialização de produtos para festas, com destaque para os bolos "fakes". No momento, o processo produtivo desses bolos é gerenciado de maneira informal e manual, utilizando uma planilha de demandas. Esta planilha é impressa e distribuída entre os departamentos responsáveis. Após a conclusão das demandas, os funcionários registram as informações diretamente na planilha, o que pode gerar inconsistências e dificultar o acompanhamento do processo.
Além disso, a cliente mencionou situações em que os funcionários, conscientes de todas as demandas futuras, tendem a priorizar a entrega de tarefas mais simples em detrimento das que exigem maior esforço.
Nesse contexto, surge a oportunidade de implementar uma solução tecnológica que centralize o controle das demandas. Essa abordagem permitirá que:

## Commands
- Gerentes de cada departamento tenham acesso em tempo real ao status de cada demanda, assegurando um melhor controle da produção.

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
- Funcionários possam visualizar apenas a demanda atual, evitando a priorização de tarefas específicas em detrimento de outras, o que promoverá uma gestão mais equilibrada e eficiente das atividades.

## Project layout
# Objetivo e Tecnologias
O aplicativo tem como principal objetivo otimizar o gerenciamento das demandas do processo produtivo dos bolos "fakes". Ele substituirá a abordagem atual, que utiliza uma planilha impressa, por uma solução tecnológica que facilitará o controle da produção.


mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Para o desenvolvimento do projeto, serão empregadas as seguintes tecnologias:

1. Linguagem Dart: Esta é a principal linguagem utilizada, tanto para a definição do frontend através do Flutter, quanto para a implementação da lógica de negócios e a comunicação com o Supabase.

1. Flutter: Um framework de desenvolvimento mobile multiplataforma, que será utilizado na construção do frontend da aplicação.

1. Supabase: Um serviço de backend que oferece diversas ferramentas, incluindo comunicação com um banco de dados PostgreSQL e autenticação de usuários com diferentes níveis de acesso, entre outros recursos.

# Principais recursos
- Integração de um sistema de transferência de informação de uma planilha excel para o aplicativo visando fácil adição das demandas.
- Gerenciamento e acompanhamento demandas por um menu com quadro de prioridade, demandas completas, restantes, em fabricação e em espera.
- Gerenciamento de funcionários e metas.

# Autores

<table>
<tr>
<td valign="top">
<a href="https://github.com/xt2012">
<img align="center" src="https://github.com/xt2012.png" height="100" />
<p align="center"> Henrique Bernardes </p>
</a>
</td>
<td valign="top">
<a href="https://github.com/dudaa28">
<img align="center" src="https://github.com/dudaa28.png" height="100" />
<p align="center"> Maria Eduarda </p>
</a>
</td>
<td valign="top">
<a href="https://github.com/gabrieladouradof">
<img align="center" src="https://github.com/gabrieladouradof.png" height="100" />
<p align="center"> Gabriela Dourado </p>
</a>
</td>
<td valign="top">
<a href="https://github.com/JAugustoM">
<img align="center" src="https://github.com/JAugustoM.png" height="100" />
<p align="center"> José Augusto </p>
</a>
</td>
<td valign="top">
<a href="https://github.com/marianaps2701">
<img align="center" src="https://github.com/marianaps2701.png" height="100" />
<p align="center"> Mariana Pereira </p>
</a>
</td>
<td valign="top">
<a href="https://github.com/Pedro-Henrique3">
<img align="center" src="https://github.com/Pedro-Henrique3.png" height="100" />
<p align="center"> Pedro Henrique </p>
</a>
</td>
<td valign="top">
<a href="https://github.com/danielle-soaress">
<img align="center" src="https://github.com/danielle-soaress.png" height="100" />
<p align="center"> Danielle Soares </p>
</a>
</td>
<td valign="top">
<a href="https://github.com/Leticia-Arisa-K-Higa">
<img align="center" src="https://github.com/Leticia-Arisa-K-Higa.png" height="100" />
<p align="center"> Leticia Arisa</p>
</a>
</td>
<td valign="top">
<a href="https://github.com/Prg-maker">
<img align="center" src="https://github.com/Prg-maker.png" height="100" />
<p align="center"> Daniel Fernandes </p>
</a>
</td>
<td valign="top">
<a href="https://github.com/SamaraAlvess">
<img align="center" src="https://github.com/SamaraAlvess.png" height="100" />
<p align="center"> Samara Alves </p>
</a>
</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
site_name: Documentação

nav:
- Instruções mkdocs: "index.md"
- Apresentação do Projeto: "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"
Expand Down

0 comments on commit 045ff42

Please sign in to comment.