Skip to content

API do Projeto Memorize Studio, baseado no padrão MVC (sem Views), utilizado: TypeScript, Node JS, Jest para testes e como ORM Node o Prisma usando MySQL para banco

Notifications You must be signed in to change notification settings

LaislaSte/Memorize-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Memorize Studio - API

badge about status badge about version

API do Projeto Memorize Studio, baseado no padrão MVC (sem Views), utilizado: TypeScript, Node JS, Jest para testes e como ORM Node: Prisma usando MySQL para banco
O projeto Memorize visa ajudar estudantes com défice de aprendizagem a memorizar conteúdos didáticos atraves de posts, com o intuito de viabilizar socialização como uma rede social

Memorize Studio Project API, based on the MVC pattern (without Views), used: TypeScript, Node JS, Jest for testing and as ORM Node: Prisma using MySQL for database
The Memorize project helps students with learning difficulties to memorize didactic content through posts, in order to enable socialization as a social network


Funcionalidade

  • Adicionar likes ao post é um comando para revisa-lo
  • Há interação entre usuários por comentarios em posts
  • Há também interação entre usuários por Chat de conversa
  • Conta com um Chat integrado com IA para auxiliar em dúvidas didáticas

Funcionality

  • Adding likes to the post is a command to review it
  • There is interaction between users by commenting on posts
  • There is also interaction between users via Chat
  • Has an integrated AI chat to help with didactic doubts

Como a API funciona - How the API works

Estrutura - Structure

Basicamente existe um CRUD para as seguintes entidades:
Basically there is a CRUD for the following entities:
User
Profile
Post
Review

As relações entre as entidades estão expressas no esquema do prisma
The relation between entities are on the prisma schema

As rotas estão no diretório de rotas no servidor
The routes are available on the server directory

Rode - Run

CLI - npm run start

Teste - Test

CLI - npm run test

Contrubua para o projeto:

tag: descrição

A tag deve ser o tipo de alteração, seguindo a referencia que estará abaixo com checkbox;
E a descrição deve ser uma mensagem de commit simples, que abranja todas as alterações dentro do PR;

Que tipo de alteração esta revisão de código introduz? (Tag)

  • feat Nova funcionalidade
  • fix Correção de um bug
  • docs Atualização de documentação
  • refact Alteração no código que não é funcionalidade nova nem correção de bug
  • perf Melhoria de performance
  • test Adição, alteração ou remoção de testes
  • build Alteração no processo de build ou em dependencias externas
  • ci Alteração de pipeline ou fluxo de publicação
  • chore Outras alterações que não modificam arquivos base ou arquivos de teste
  • revert Reversão de commits anteriores

Exemplo: fix/where: message

About

API do Projeto Memorize Studio, baseado no padrão MVC (sem Views), utilizado: TypeScript, Node JS, Jest para testes e como ORM Node o Prisma usando MySQL para banco

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published