juniel-filappi/project-ed-tech

🗺 Ed Tech

Node.JS | Vue.JS

Sobre o projeto · Tecnologias utilizadas · Primeiros passos · Padrões do projeto

💭 Sobre

O código consiste em uma aplicação onde seja possível realizar a matrícula dos alunos na turma de programação web da instituição Edtech.

---

👨‍💻 Tecnologias Utilizadas

• Node.JS;
• Vue.JS;
• TypeScript.
• Vuetify.
• Prisma 10.
• Express.JS.
• Vite.JS.
• Cypress.

---

⁉ Primeiros passos

🤔 Pré-requisitos

Para conseguir utilizar o projeto e contribuir nele, basta seguir as instruções abaixo:

• O Node.js é OBRIGATÓRIO para executar esse projeto e é RECOMENDADO usar a versão LTS.
• O NPM ou Yarn são OBRIGATÓRIO para o gerenciamento dos pacotes da aplicação.
• O Git é OBRIGATÓRIO para o controle de versão do projeto.

---

📝 Passo a passo

Primeiro clone o repositório em seu computador, por meio do terminal utilizando o comando:

1. Clonando o repositório

  # Clone o repositório
  $ git clone https://github.com/Juninho-dev/challenge-growdev.git
  # Entre na pasta raiz da aplicação
  $ cd challenge-growdev

2. Iniciando o Projeto

  # Instale as dependências da aplicação web
  $ cd web && yarn # ou npm install
  # Execute o comando abaixo para iniciar o projeto
  $ yarn dev

  # Instale as dependências da aplicação api
  $ cd api && yarn # ou npm install
  # Execute o comando abaixo para iniciar o servidor
  $ yarn dev

---

💯 Padrões do projeto

• SOLID
• MVC
• Repository Pattern

---

Documentação da arquitetura

O projeto esta dividido em:

• Controller
• Middleware
• Repositories
• Validators
• Routes
• Helpers

Controller

A camada Controller atua como intermediária entre as solicitações enviadas pelo Front-end e as respostas fornecidas pelo Model, processando os dados inseridos pelo usuário e transmitindo-os para outras camadas. Essa camada é fundamental para a estruturação da arquitetura MVC (Model-View-Controller).

Middleware

Este componente é encarregado de filtrar as requisições e manipular as informações recebidas. Foram desenvolvidos dois middlewares: o primeiro, denominado authenticateToken, tem a responsabilidade de verificar se o usuário está autenticado na plataforma; o segundo, denominado errorMiddleware, trata os erros da aplicação seguindo o padrão apiMessage.

Repositories

Responsável por implementar as lógicas de negócio relacionadas aos modelos de banco de dados.

Validators

Responsável por receber, tratar e validar as informações provenientes do Front-end.

Routes

Responsável por definir e gerenciar todas as rotas da API.

Helpers

Criado para desenvolver funções que podem ser reutilizadas em várias partes do código, visando manter a base do código organizada e legível.

---

🚧 Lista de Atividades

TO DO API

• Adding ORM Prisma 10.
• Create Repository Pattern module.
• Use SOLID Arquiteture.
• Create auth routes.
• Create Middleware authenticate.
• Implementing tratative errors.
• Use the default response api.
• Create students routes.
• Create swagger documentation.
• Create tests integration.

TO DO WEB

• Install vuetify and config theme colors.
• Create Login page.
• Create Register page.
• Create Dashboard page.
• Create Students page.
• Configure vue-router.
• Configure cypress and automatized tests.
• Create middleware authenticate private routes.
• Adding sweet-alert2 for return messages in application.
• Install axios and configure api.ts

---

^{Feito com 💙 por 👾Juniel ® 2024.}