https://github.com/alezzott/ptr-challenge-front

https://github.com/alezzott/ptr-challenge-front

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/alezzott/ptr-challenge-front
• Owner: alezzott
• Created: 2024-04-05T01:42:23.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-05T01:58:34.000Z (8 months ago)
• Last Synced: 2024-04-05T02:45:37.894Z (8 months ago)
• Language: TypeScript
• Size: 78.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Documentação do Front-end do Projeto

## Visão Geral

Este projeto é uma aplicação web desenvolvida com React e Next.js, focada na gestão de empreendimentos. A aplicação permite aos usuários visualizar, pesquisar e gerenciar informações sobre empreendimentos, incluindo a criação, edição e exclusão de registros.

## Funcionalidades Principais

1. **Listagem de Empreendimentos**: A aplicação carrega uma lista de empreendimentos a partir de uma API externa. Os empreendimentos são exibidos com detalhes como nome, endereço, status e propósito.

2. **Pesquisa de Empreendimentos**: Os usuários podem pesquisar empreendimentos por nome usando um campo de busca. Os resultados da pesquisa são filtrados em tempo real e exibidos na lista.

3. **Navegação**: A aplicação inclui um cabeçalho com botões para navegar para a página de registro de novos empreendimentos e voltar para a página inicial.

4. **Exclusão de Empreendimentos**: Os usuários podem excluir empreendimentos existentes. A exclusão é confirmada através de um modal de confirmação.

5. **Paginação**: A aplicação suporta paginação, permitindo aos usuários carregar mais empreendimentos conforme necessário.

## Tecnologias Utilizadas

- **React**: Biblioteca JavaScript para construção de interfaces de usuário.

- **Next.js**: Framework baseado em React para desenvolvimento de aplicações web.

- **Material-UI**: Biblioteca de componentes UI para React.

- **Axios**: Cliente HTTP para fazer requisições à API.

## Instrução de Uso

1. **Instalação**: Clone o repositório do projeto e instale as dependências com `npm install` ou `yarn install`.

2. **Execução**: Inicie o servidor de desenvolvimento com `npm run dev` ou `yarn dev`.

3. **Navegação**: Acesse a aplicação no navegador em `http://localhost:3000`.

## Sugestões de Melhorias no layout

- **Responsividade**: Implemente design responsivo para garantir que a aplicação seja acessível e fácil de usar em dispositivos móveis e desktop.

- **Espaçamento e Alinhamento**: Avalie o espaçamento entre os elementos da interface e o alinhamento do texto para garantir uma aparência limpa e profissional.

- **Navegação**: Melhore a navegação, tornando-a mais intuitiva e fácil de encontrar. Considere adicionar um menu de navegação fixo ou um cabeçalho persistente.

- **Feedback Visual**: Implemente feedback visual para ações do usuário, como cliques ou carregamento de páginas, para melhorar a experiência do usuário.

- **Acessibilidade**: Garanta que a aplicação seja acessível a todos os usuários, incluindo aqueles com deficiências, através de etiquetas apropriadas, contraste de cores adequado e suporte a leitores de tela.