https://github.com/caiogmrocha/stud-io-api
API Rest da plataforma de estudos Stud.io
https://github.com/caiogmrocha/stud-io-api
clean-architecture clean-code tdd testing
Last synced: 9 months ago
JSON representation
API Rest da plataforma de estudos Stud.io
- Host: GitHub
- URL: https://github.com/caiogmrocha/stud-io-api
- Owner: caiogmrocha
- Created: 2022-12-11T18:43:30.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-25T16:39:37.000Z (about 2 years ago)
- Last Synced: 2025-06-09T21:05:20.647Z (about 1 year ago)
- Topics: clean-architecture, clean-code, tdd, testing
- Language: TypeScript
- Homepage:
- Size: 314 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
Awesome Lists containing this project
README
---
description: Introdução ao Projeto Stud.io
---
# Prefácio
## Visão Geral
O projeto Stud.io é uma plataforma que tem por objetivo fornecer a usuários uma plataforma social para compartilhar conhecimento entre professores e estudantes. A plataforma funcionará como uma rede social que permitirá a seus usuários fazerem publicações e streaming de aulas ao vivo com chats em tempo real para compartilhar conhecimento.
## Objetivo
O projeto fará parte do meu portfólio de desenvolvimento, inicialmente não tendo objetivo de lucro e sim proporcionar um microambiente com regras de negócio específicas para evoluir e demonstrar minhas habilidades e meu conhecimento como desenvolvedor.
Claro que isso implica em aprofundar os conhecimentos no ecossistema JavaScript, já que o Web Service Back-end foi desenvolvido com Node.js e, futuramente, também planejo desenvolver front-ends para a aplicação, construídos com React.js e Vue.js.
## Propósito da API
A Web API tem por objetivo ser um intermediário entre o cliente e os serviços da aplicação, e.g., banco de dados, serviços de cache, etc. Para cumprir seu propósito, a API deverá disponibilizar endpoints HTTP e WS para acesso às informações da aplicação.
Além disso, tarefas de processamento pesado como o armazenamento e transmissão de lives, envios de e-mail e demais operações custosas, serão processadas pelo serviço com estratégias de performance, como filas distribuidas, Streams API, dentre outros.