IHC-CATALOG

Projeto

O catálogo de Instrumentos de Avaliação de Experiência do usuário é um projeto para conclusão da cadeira de Interação Humano Computador (IHC) do curso de Sistemas e Midias Digitais (SMD) da Universidade Federal do Ceará.

O catálogo será uma Aplicação Web com intuito de catalogar e filtrar Instrumentos de Avaliação UX permitindo que o usuário tenha um local que centralize essas informações e evite ter que ir de site em site buscando por meios de avaliar a experiência do usuário.

Dados

• Cliente:
  • Ticianne Darin
• Produto:
  • Ferramenta que disponibilize para o usuário um conjunto de instrumentos de avaliação e redirecione para o link de acesso a esses instrumentos. Tal ferramenta deve ser capaz de gerenciar esses instrumentos.
• Prazo:
• Equipe | Dante Araújo | Drielle Furtado | Luis Eduardo | Manoel Costa | Maxwell de Sousa |
• Ferramentas

  • Ferramentas de Gerenciamento:

    

  • Ferramentas de Prototipação e Design: Figma, Miro, Canva.

    

  • Ferramentas de Desenvolvimento:

    • Editores de Texto:

      

    • Banco de Dados:

      

    • Frameworks:

      

      • Packages

        • Package Manager:

        • Components:

        • Routes:

        • Build Tool:

Requisistos Funcionais

Acompanhe o andamento da nossa aplicação

Código	Descrição	Codificação	Status
RF001	Autenticação(admin)	backend	Não concluído
RF002	Sugestão de novos instrumentos(usuário)	backend	Concluido
RF003	Filtragem de conteúdos por categorias(usuário)	backend	Concluído
RF004	Ferramenta de busca por palavras chaves(usuário)	backend frontend fronend	Concluído
RF005	Aprovar sugestões(admin)	backend	Concluído
RF006	Reprovar sugestões(admin)	backend	Concluído
RF007	Visualizar instrumentos aprovados ou reprovados(admin)	backend código	Concluído
RF008	Adição de subcategorias(admin)	backend	Concluído
RF009	Remoção de subcategorias(admin)	backend	Concluído
RF010	Edição de subcategorias(admin)	backend	Concluído
RF011	Mostrar lista de resultados na busca(usuário)	frontend	Concluído
RF012	Mostrar formulário de sugestão(usuário)	frontend	Concluído
RF013	Mostrar lista de resultados filtrados(usuário)	frontend	Concluído
RF014	Pesquisar por categorias específicas(usuário)	frontend backend backend	Concluído
RF015	Mostrar subcategorias da pesquisa por categorias(usuário)	frontend	Concluído
RF016	Mostrar página de explicação da aplicação (usuário)	frontend	Concluído
RF017	Mostrar página de saiba mais (usuário)	frontend	Concluído
RF018	Mostrar página de login (admin)	frontend	Concluído
RF019	Mostrar página de gerenciamento de instrumentos (admin)	fronted	Concluído
RF020	Adição de Instrumentos (admin)	fronend backend	Concluído
RF021	Edição de Instrumentos (admin)	frontend backend	Concluído
RF022	Remoção de Instrumentos (admin)	backend	Concluído
RF023	Filtrar instrumentos na página de gerenciamento de insturmentos	MUI DataGrid	Concluído
RF024	Editar Filtros na página de resultados da busca (usuário)	frontend frontend	Concluído
RF025	Selecionar outras páginas de resultados ((usuário)	frontend frontend	Concluído

Instruções

1. Clone o projeto em uma pasta de sua preferência.
2. Acesse a branch develop, é nela que encontram-se os arquivos atuais em desenvolvimento necessários para rodar a aplicação
3. Agora é possível usar nossa primeira realease que ja está na própria branch master

git clone https://github.com/dantearaujo1/ihc-catalog && cd ihc-catalog

# Optional
git checkout develop

2. Existem três maneiras para rodar a aplicação

Usando Batch Script da pasta dist (FORMA MAIS FÁCIL)

• Entre na pasta dist e execute o arquivo runWindows.bat, ele irá se encarregar de executar os comandos e rodar os servidores.

Usando Docker

Será preciso ter o Docker instalado no seu computador

• Primeiro, crie um build da imagem docker a partir do Dockerfile do repositório.

docker build -t ihc .

• Depois dê inicio ao seu container docker com o seguinte comando:

docker run -dp 5173:5173 ihc

• Basta acessar a aplicação

      Acesse a aplicação aqui

Usando Node Package Manager (NPM)

Tenha instalado a versão 18.11.0 ou superior do NodeJS

• Entre na sua pasta raiz da pasta clonada e digite o seguinte comando:

npm install

• [OBS] Caso fique preso na instalação, aperte CTRL-C para cancelar e use o commando npm install em cada pasta dentro da raiz nessa ordem:
• [OBS] Esse é um bug que acontece em algumas versões do node quando se tenta dar npm install em subpastas das pastas que o comando rodou primeiramente.

cd frontend
npm install
cd ..
cd backend
npm install
cd ..
npm install

• Espere a instalação terminar e poderá rodá-la com o seguinte comando:

npm run dev

• Basta acessar sua aplicação

      Acesse a aplicação aqui

Estrutura de Pastas

|-- .dockerignore
|-- .gitignore
|-- Dockerfile
|-- README.md
|-- backend
|   |-- .env
|   |-- app.js
|   |-- articleXsub.json
|   |-- controllers
|   |   |-- articleController.js
|   |   |-- categoryController.js
|   |   |-- suggestionController.js
|   |   `-- userController.js
|   |-- dataa.json
|   |-- models
|   |   |-- Article.js
|   |   |-- Category.js
|   |   |-- Group.js
|   |   |-- Suggestion.js
|   |   `-- User.js
|   |-- package-lock.json
|   |-- package.json
|   |-- routes
|   |   |-- articleRoutes.js
|   |   |-- categoryRoutes.js
|   |   |-- loginRoutes.js
|   |   `-- suggestionRoutes.js
|   |-- sanitized_data.json
|   `-- scratch.js
|-- dist
|   `-- runWindows.bat
|-- frontend
|   |-- index.html
|   |-- package-lock.json
|   |-- package.json
|   |-- public
|   |   |-- about-teal.png
|   |   |-- header-teal.png
|   |   |-- helper-1.png
|   |   |-- helper-2.png
|   |   |-- helper-3.png
|   |   |-- helper-4.png
|   |   |-- helper-teal.png
|   |   |-- login-purple.png
|   |   |-- logo-grauna.svg
|   |   |-- people
|   |   |   |-- Drielle.jpg
|   |   |   |-- Luis.jpg
|   |   |   |-- Manoel.jpg
|   |   |   |-- Max.jpg
|   |   |   `-- dan.png
|   |   |-- result-not-found-teal.png
|   |   |-- sent-form-teal2.png
|   |   `-- vite.svg
|   |-- src
|   |   |-- App.css
|   |   |-- App.jsx
|   |   |-- assets
|   |   |   |-- ComponentStyle.jsx
|   |   |   |-- react.svg
|   |   |   `-- themes.jsx
|   |   |-- components
|   |   |   |-- ArticleCard.jsx
|   |   |   |-- ConfirmDialog.jsx
|   |   |   |-- Filter
|   |   |   |   |-- SideFilter.jsx
|   |   |   |   `-- TagSelect.jsx
|   |   |   |-- GroupBadge.jsx
|   |   |   |-- IHCConfirmDialog.jsx
|   |   |   |-- IHCDataGrid.jsx
|   |   |   |-- Modals
|   |   |   |   `-- InstrumentAdd.jsx
|   |   |   |-- Navigation
|   |   |   |   |-- Footer.jsx
|   |   |   |   |-- InstrumentManager.jsx
|   |   |   |   |-- NavigationBar.jsx
|   |   |   |   |-- NavigationHeader.jsx
|   |   |   |   |-- SubcategoriesManager.jsx
|   |   |   |   |-- SuggestionList.jsx
|   |   |   |   `-- SuggestionManager.jsx
|   |   |   |-- PageCard.jsx
|   |   |   |-- Panels
|   |   |   |   |-- InstrumentAddPanel.jsx
|   |   |   |   |-- InstrumentEditPanel.jsx
|   |   |   |   |-- InstrumentManagerPanel.jsx
|   |   |   |   |-- SubAddPanel.jsx
|   |   |   |   |-- SubEditPanel.jsx
|   |   |   |   |-- SubManagerPanel.jsx
|   |   |   |   `-- SuggestionManagerPanel.jsx
|   |   |   |-- ResultNotFound.jsx
|   |   |   `-- SuggestionDialogView.jsx
|   |   |-- index.css
|   |   |-- main.jsx
|   |   |-- routes
|   |   |   |-- About.jsx
|   |   |   |-- Admin.jsx
|   |   |   |-- Home.jsx
|   |   |   |-- InstrumentDetail.jsx
|   |   |   |-- Login.jsx
|   |   |   |-- ResultList.jsx
|   |   |   |-- Tutorial.jsx
|   |   |   `-- routes.jsx
|   |   `-- services
|   `-- vite.config.js
|-- logs
|-- package-lock.json
|-- package.json
|-- scrathfile.json
`-- todo.norg