Este projeto é parte da disciplina e tem como objetivo permitir que os alunos apliquem os conceitos e temas abordados em aula. O projeto consiste no desenvolvimento de um sistema web, onde o aluno tem a liberdade de escolher o domínio do sistema, desde que atenda aos requisitos definidos. Este repositório contém o código-fonte do projeto web que utiliza as seguintes tecnologias: Node.js, Express.js, MongoDB, EJS, entre outras.
Neste ciclo inicial, cada projeto deve atender aos seguintes requisitos e realizar as seguintes atividades:
- Definir um nome (e um logo) para o sistema.
- Criar um repositório na plataforma GitHub.
- Definir um template e padrão visual para o site, incluindo cabeçalho e rodapé.
- Criar um arquivo para conter as configurações da aplicação web, como senhas e parâmetros necessários para o seu funcionamento (Dotenv).
- Criar uma página inicial para o site com um breve resumo da proposta e os links para as demais páginas. A página inicial também deve conter um formulário de login.
- Criar uma página com uma descrição detalhada do que será desenvolvido.
- Criar uma página para listar as tecnologias e ferramentas que serão utilizadas. Todas as bibliotecas utilizadas devem ser listadas nesta página.
- Criar uma página para descrever o desenvolvedor do projeto e outras pessoas relacionadas a ele.
- Criar uma página de contato, onde os usuários poderão enviar mensagens por email para os desenvolvedores da ferramenta. Os campos obrigatórios são nome, e-mail, assunto e mensagem (Nodemailer).
Para o desenvolvimento deste ciclo, é obrigatório utilizar o framework Express.js. Os demais pacotes e recursos utilizados são de livre escolha de cada desenvolvedor. Neste ciclo, não é necessário criar uma API para separação entre back-end e front-end. O conteúdo e os dados devem ser disponibilizados em um único servidor. No entanto, é permitido o uso de um framework front-end como React, Vue ou Angular, desde que estejam integrados em um único projeto.
Nesta segunda etapa do projeto, o objetivo é criar um sistema dinâmico integrado com um banco de dados (relacional ou NoSQL) por meio de uma API Web (back-end) e um cliente web (front-end) que consumirá a API desenvolvida.
Como requisito principal, o sistema deve permitir pelo menos 3 tipos de cadastros (operações de CRUD completas) que apresentem um relacionamento de um-para-muitos ou muitos-para-muitos, de acordo com a escolha de cada aluno. Um desses cadastros deve ser relacionado ao usuário. O front-end da aplicação deve consumir a API desenvolvida, realizar a validação dos dados fornecidos pelo usuário, além de tratar os erros e mensagens geradas pela API.
A API também deve realizar a validação dos campos, considerando que os dados podem vir de uma fonte diferente do cliente desenvolvido. Mensagens de erro e sucesso devem ser enviadas juntamente com as respostas. Os métodos HTTP GET, POST, PUT e DELETE devem ser utilizados de acordo com a operação a ser executada. O banco de dados pode ser relacional (ex. MySQL ou PostgreSQL) ou NoSQL (ex. MongoDB).
Os Seguintes recursos foram desenvolvidos:
- Implementação de uma API REST.
- Consumo assíncrono dos dados da API pelo cliente.
- Cadastro de usuário.
- Controle de acesso com autenticação de usuários utilizando JWT (API e cliente).
- Possibilidade do usuário alterar seus dados e excluir sua conta.
- Listagem dos dados de pelo menos uma coleção, permitindo paginação e ordenação por diferentes atributos.
- Exibição dos detalhes de um registro de cada coleção.
- Inserção de novos registros para cada coleção com validação adequada.
- Atualização de um registro para cada coleção.
- Exclusão de um registro de cada coleção.
- Desenvolvimento de um relacionamento (1-N ou N-M) entre essas coleções, onde um formulário de cadastro deve permitir a escolha de um ou vários itens relacionados.
- Validação de entradas de dados no cliente e no servidor.
- Tratamento de erros no cliente e no servidor.
- Atualização do arquivo de configuração com os detalhes de acesso ao banco de dados.
- Implementação de uma rota que realiza uma carga automática dos dados, garantindo que cada coleção tenha pelo menos 5 registros prévios.
- Desenvolvimento de uma rota que exiba um relatório no formato de gráfico e que possa ser exportado em PDF.
O projeto consiste em uma aplicação web para gerenciamento de livros, com as seguintes funcionalidades:
- Listar todos os livros cadastrados
- Adicionar um novo livro
- Obter os detalhes de um livro
- Atualizar informações de um livro
- Excluir um livro
- Cadastro de usuários
- Alteração de cadastro e exclusão de conta
Certifique-se de ter as seguintes ferramentas instaladas em seu sistema:
- Node.js (versão 18 ou superior)
- MongoDB (instância local ou remota)
Siga as etapas abaixo para executar a aplicação em seu ambiente local:
-
Clone este repositório para o seu diretório local:
git clone https://github.com/seu-usuario/projeto-web.git -
Acesse o diretório do projeto:
cd projeto-web -
Instale as dependências do projeto:
npm install -
Renomeie o arquivo
.env.examplepara.enve configure as variáveis de ambiente necessárias, como a URL de conexão com o MongoDB. -
Inicie a aplicação:
npm start -
Acesse a aplicação em seu navegador web:
http://localhost:3000
O arquivo .env é usado para armazenar informações sensíveis e variáveis de ambiente do projeto. Antes de executar o projeto, você precisará criar esse arquivo e configurar as seguintes variáveis de ambiente:
Certifique-se de substituir os valores fictícios pelos dados reais correspondentes.
EMAIL_HOST: O endereço do servidor de email a ser usado para envio de emails.EMAIL_PORT: A porta do servidor de email.EMAIL_USER: O usuário do email utilizado para autenticação.EMAIL_SENHA: A senha do email para autenticação.EMAIL_DESTINO: O endereço de email de destino para receber as mensagens enviadas.PORT: A porta em que o servidor web será executado localmente.MONGODB_URL: A URL de conexão para o banco de dados MongoDB.USERNAME: O nome de usuário para autenticação no sistema.PASSWORD: A senha para autenticação no sistema.
Certifique-se de criar o arquivo .env na raiz do projeto e definir as variáveis de ambiente conforme mostrado acima. Não compartilhe ou inclua esse arquivo no controle de versão, pois ele contém informações sensíveis.
O projeto inclui testes automatizados para as funcionalidades da API REST. Os testes são desenvolvidos utilizando a biblioteca Cypress.
Para executar os testes automatizados, certifique-se de que a aplicação esteja em execução. Em seguida, execute o seguinte comando no diretório raiz do projeto:
npm run cy:open
Isso abrirá a interface do Cypress, onde você poderá selecionar e executar os testes desejados ao todo existem 7 arquivos de testes somando um total de 35 testes automatizados.
API.cy.js.mp4
A estrutura de arquivos do projeto é organizada da seguinte forma:
app.js: arquivo principal do aplicativo, configuração do servidor Express e definição das rotas.routes/index.js: arquivo com as rotas da aplicação.models/livro.js: arquivo contendo o modelo do livro para o MongoDB.controllers/livrosController.js: arquivo com os controladores das rotas relacionadas aos livros.public/: diretório que contém arquivos estáticos, como CSS e JavaScript.views/: diretório que contém os templates EJS utilizados para renderizar as páginas HTML.cypress/: diretório que contém os arquivos de testes automatizados.
Este projeto utiliza GitHub Actions para integração contínua. A configuração da CI pode ser encontrada no arquivo .github/workflows/ci.yml. Os passos da CI incluem:
-
Checkout do Repositório: O código do repositório é clonado no ambiente de execução da CI.
-
Configuração do Ambiente Node.js: É configurada a versão do Node.js especificada no arquivo de configuração.
-
Instalação de Dependências: Todas as dependências do projeto são instaladas usando o npm.
-
Execução de Testes: Os testes automatizados são executados para garantir a integridade do código.
Para mais detalhes, consulte o Arquivo CI.
Este projeto está licenciado sob a Licença MIT. Consulte o arquivo LICENSE.