Skip to content

Commit

Permalink
Inclusão do arquivo REAME.md e configuração do pages do projeto.
Browse files Browse the repository at this point in the history
JoaoEduardoP committed Oct 30, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent ede1ddf commit d116e3b
Showing 14 changed files with 271 additions and 2 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/static.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: ci
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: pip install mkdocs-include-dir-to-nav
- run: mkdocs gh-deploy --force
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
# 2024.2-T01-FamintosBurguer
Repositório de projeto da disciplina de REQ-T1.
# REQ-UnB-Docs

Repositório para Documentação do projeto **Famintos Burguer** da matéria de requisitos da UNB.

## Equipe

Somos formados por 5 estudandates do curso de Engenharia de Software, Conheça a equipe de desenvolvimento abaixo:

### Grupo:

| **📸** | [<img src="https://avatars.githubusercontent.com/u/118384776?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/78875892?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/86434947?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/122989234?v=4" width=100>]()| [<img src="https://avatars.githubusercontent.com/u/124713089?v=4" width=100>]()|
|:---------:|:------------------------------------------------------------------------------:|:------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|
| **Nome** | [Isaac Batista Pessoa De Moraes](https://https://github.com/isaacbatista26) | [João Eduardo Pereira Rabelo](https://github.com/JoaoEduardoP) | [Letícia Torres Soares Martins](https://github.com/leticiatmartins) | [Tulio Augusto Celeri](https://github.com/TulioCeleri) | [William Bernardo Da Silva](https://github.com/willxbernardo) |
| **Cargo** |Desenvolvedor | Desenvolvedor | Desenvolvedor |Desenvolvedor | Desenvolvedor | |

## Acesse nossa documentação e saiba mais:

[Famintos Burguer](https://joaoeduardop.github.io/REQ-Eng.Software-UnB-Docs/)
27 changes: 27 additions & 0 deletions docs/ProdutoProjeto/1_Cenário.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# 1. Cenário Atual Do Cliente e Do Negócio

___________________________________________________________________________________

## 1.1 Introdução ao Negócio e Contexto
Descreva a empresa ou o cliente, destacando o setor de atuação, o público-alvo, e o histórico relevante para
o projeto.

___________________________________________________________________________________

## 1.2 Identificação da Oportunidade ou Problema
Explique o motivo pelo qual o projeto é necessário, seja para resolver um problema ou aproveitar uma
oportunidade de mercado.

___________________________________________________________________________________

## 1.3 Desafios do Projeto
Descreva os principais obstáculos ou dificuldades enfrentados pelo cliente ou pelo negócio, sejam eles
técnicos, de conhecimento ou operacionais.

___________________________________________________________________________________

## 1.4 Segmentação de Clientes
Descreva os diferentes perfis de clientes atendidos pelo negócio, ajudando a entender o público-alvo da
solução.

___________________________________________________________________________________
31 changes: 31 additions & 0 deletions docs/ProdutoProjeto/2_Solucao.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 2. Solução Proposta

___________________________________________________________________________________

## 2.1 Objetivos do Produto
Apresente o que se espera alcançar com o produto e como ele irá resolver o problema ou explorar as
oportunidades identificadas.
___________________________________________________________________________________

## 2.2 Características da Solução
Apresente (de maneira preliminar) as principais características que a solução deve ter, informando como
elas irão atender às necessidades do cliente.
___________________________________________________________________________________

## 2.3 Tecnologias a Serem Utilizadas
Informe quais serão as tecnologias a serem utilizadas para a construção da solução proposta.
___________________________________________________________________________________

## 2.4 Pesquisa de Mercado e Análise Competitiva
Apresente uma análise das soluções similares já existentes no mercado e como a nova solução poderá se
diferenciar delas.
___________________________________________________________________________________

## 2.5 Análise de Viabilidade
Avalie a viabilidade técnica, prazo, financeira e de mercado da solução, demonstrando se ela é sustentável
e adequada.
___________________________________________________________________________________

## 2.6 Impacto da Solução
Finalize destacando os benefícios esperados da solução e o impacto que ela terá no negócio do cliente.
___________________________________________________________________________________
25 changes: 25 additions & 0 deletions docs/ProdutoProjeto/3_Estrategia.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 3. Estratégias De Engenharia De Software

___________________________________________________________________________________

## 3.1 Estratégia Priorizada
Abordagem de Desenvolvimento de Software: informe qual será a abordagem (dirigida por plano, ágil,
híbrida) que irá guiar o desenvolvimento do produto proposto.
Ciclo de vida: informe o ciclo de vida de desenvolvimento de software a ser utilizado, em alinhamento com
a abordagem escolhida.
Processo de Engenharia de Software: informe o processo de desenvolvimento de software a ser utilizado
para a construção do produto proposto.

___________________________________________________________________________________

## 3.2 Quadro Comparativo
Apresente um quadro comparando dois possíveis processos de desenvolvimento de software que poderiam
ser utilizados para o desenvolvimento do produto proposto.

___________________________________________________________________________________

## 3.3 Justificativa
A partir das informações apresentadas na seção anterior, reporte a justificativa que fundamenta a escolha
de um dos processos comparados, para o desenvolvimento do produto proposto.

___________________________________________________________________________________
10 changes: 10 additions & 0 deletions docs/ProdutoProjeto/4_Cronograma.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# 4. Cronograma e Entregas

Apresente o planejamento temporal do projeto, com as fases de desenvolvimento e prazos de entrega,
especificando suas datas de início e de fim, bem como os produtos a serem gerados. O planejamento do
projeto deve ser atualizado de maneira sucessiva, a partir da realização de cada ciclo (sprint, iteração) de
desenvolvimento.
Deve ser apresentado o planejamento de TODO o projeto, ainda que, preliminar. Ao longo da disciplina,
tal planejamento deverá ser atualizado.

___________________________________________________________________________________
22 changes: 22 additions & 0 deletions docs/ProdutoProjeto/5_Interação.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# 5. Interação Entre Equipe E Cliente

___________________________________________________________________________________

## 5.1 Composição da Equipe
Informe a equipe que estará envolvida no desenvolvimento da solução e suas respectivas responsabilidades.
Página 4 de 14.

___________________________________________________________________________________

## 5.2 Comunicação
Descreva as ferramentas e métodos a serem usados para manter a equipe e o cliente alinhados, além da
frequência de reuniões e interações. Também deve ser informado como será realizada a comunição entre os
membros da equipe.

___________________________________________________________________________________

## 5.3 Processo de Validação
Informe como o produto será validado antes de sua implementação final, garantindo que atenda às
expectativas do cliente.

___________________________________________________________________________________
35 changes: 35 additions & 0 deletions docs/ProdutoProjeto/6_Lições.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 6. Lições Aprendidas

___________________________________________________________________________________

## 6.1 Unidade 1
[Liste as lições aprendidas na retrospectiva, com ênfase especial nas ações a serem tomadas para
melhorar, por exemplo: o ambiente de desenvolvimento, o processo ou a colaboração da equipe.]
[Aqui, também devem estar registradas as dificuldades que a equipe teve durante a unidade, e como
conseguiu (ou não superá-las).]

___________________________________________________________________________________

## 6.2 Unidade 2
[Liste as lições aprendidas na retrospectiva, com ênfase especial nas ações a serem tomadas para
melhorar, por exemplo: o ambiente de desenvolvimento, o processo ou a colaboração da equipe.]
[Aqui, também devem estar registradas as dificuldades que a equipe teve durante a unidade, e como
conseguiu (ou não superá-las).]

___________________________________________________________________________________

## 6.3 Unidade 3
[Liste as lições aprendidas na retrospectiva, com ênfase especial nas ações a serem tomadas para
melhorar, por exemplo: o ambiente de desenvolvimento, o processo ou a colaboração da equipe.]
[Aqui, também devem estar registradas as dificuldades que a equipe teve durante a unidade, e como
conseguiu (ou não superá-las).]

___________________________________________________________________________________

## 6.4 Unidade 4
[Liste as lições aprendidas na retrospectiva, com ênfase especial nas ações a serem tomadas para
melhorar, por exemplo: o ambiente de desenvolvimento, o processo ou a colaboração da equipe.]
[Aqui, também devem estar registradas as dificuldades que a equipe teve durante a unidade, e como
conseguiu (ou não superá-las).]

___________________________________________________________________________________
1 change: 1 addition & 0 deletions docs/ProdutoProjeto/7_Referências.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 7. Referências Bibiliográficas
Binary file added docs/img/Unb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/hamburguer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/hamburguer_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# <center>**Famintos Burguer 🍔**</center>

_________________________________________________________________________________
<center>
![UNB](img/Unb.png)
</center>

UNIVERSIDADE DE BRASÍLIA
_________________________________________________________________________________
## *Requisitos de Software*

Bem-vindo à página inicial do projeto da matéria de Requisitos de Software da Universidade de Brasília (UNB). Nesta página, apresentamos nosso projeto de desenvolvimento de um aplicativo desktop para auxiliar na gestão de pedidos de restaurantes e food trucks.


_________________________________________________________________________________
## *Sobre o Projeto*

Nosso projeto visa criar um aplicativo desktop para empresas no ramo alimentício, será capaz de auxiliar nas demandas de pedidos, atendimento e acompanhamento das demandas desse tipo de empresa.

Visite nossa página do GitHub: [Famintos Burguer](https://github.com/mdsreq-fga-unb/2024.2-T01-FamintosBurguer)
_________________________________________________________________________________
## *Equipe*

Somos formados por 5 estudandates do curso de Engenharia de Software, Conheça a equipe de desenvolvimento abaixo:
_________________________________________________________________________________
### *Grupo*

| **📸** | [<img src="https://avatars.githubusercontent.com/u/118384776?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/78875892?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/86434947?v=4" width=100>]() | [<img src="https://avatars.githubusercontent.com/u/122989234?v=4" width=100>]()| [<img src="https://avatars.githubusercontent.com/u/124713089?v=4" width=100>]()|
|:---------:|:------------------------------------------------------------------------------:|:------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|
| **Nome** | [Isaac Batista Pessoa De Moraes](https://https://github.com/isaacbatista26) | [João Eduardo Pereira Rabelo](https://github.com/JoaoEduardoP) | [Letícia Torres Soares Martins](https://github.com/leticiatmartins) | [Tulio Augusto Celeri](https://github.com/TulioCeleri) | [William Bernardo Da Silva](https://github.com/willxbernardo) |
| **Cargo** |Desenvolvedor | Desenvolvedor | Desenvolvedor |Desenvolvedor | Desenvolvedor |

_________________________________________________________________________________
40 changes: 40 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
site_name: Famintos Burguer

nav:
- Projeto e Documentação: index.md
- Visão Do Produto E Projeto: ProdutoProjeto

markdown_extensions:
- tables
- md_in_html
- toc:
title: Tópicos

theme:
name: material
palette:
- scheme: default
primary: yellow
accent: amber
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- scheme: slate
primary: indigo
accent: light-blue
toggle:
icon: material/brightness-4
name: Switch to light mode

logo: img/hamburguer.png
favicon: img/hamburguer_icon.png
highlightjs: true

extra_css:
- stylesheets/extra.css

plugins:
- search
- include_dir_to_nav

0 comments on commit d116e3b

Please sign in to comment.