Kecbm / Tryitter

O Tryitter é uma rede social, cujo objetivo é proporcionar um ambiente em que as pessoas estudantes poderão por meio de textos e imagens compartilhar suas experiências e também acessar posts que possam contribuir para seu aprendizado.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Boas vindas ao repositório do Tryitter 🐦

O que foi desenvolvido 👩‍💻

O Tryitter é uma rede social, totalmente baseada em texto. Cujo objetivo é proporcionar um ambiente em que as pessoas estudantes poderão por meio de textos e imagens compartilhar suas experiências e também acessar posts que possam contribuir para seu aprendizado.

Arquitetura 🧩

A arquitetura inicial foi definida da seguinte forma:

Conforme visto na imagem acima, haverá um Front-End que será responsável por interagir com as pessoas estudantes e mandar as muitas requisições para o Back-End, que, por sua vez, será responsável por manter as informações atualizadas em um banco de dados MySQL Server usando o Framework Entity.

Funcionalidades 📱

  1. Implementar um C.R.U.D. para as contas de pessoas estudantes;
  2. Implementar um C.R.U.D. para um post de uma pessoa estudante;
  3. Alterar um post depois de publicado.

Desenvolvimento 🎯

Nessa rede social, as pessoas estudantes devem conseguir se cadastrar com nome, e-mail, módulo atual que estão estudando na Trybe, status personalizado e senha para se autenticar. Deve ser possível também alterar essa conta a qualquer momento, desde que a pessoa usuária esteja autenticada.

Uma pessoa estudante deve poder também `publicar posts em seu perfil, que poderão conter texto com até 300 caracteres e arquivos de imagem, além de conseguir pesquisar outras contas por nome e optar por listar todos seus posts.

Métodos

Requisições para a API seguem os padrões:

Método Descrição
GET Retorna informações de um ou mais registros.
POST Utilizado para criar um novo registro.
PUT Utilizado para atualiza as propriedades.
DELETE Utilizado para deletar um registro.

Respostas

Código Descrição
200 Requisição executada com sucesso.
201 Novo recurso criado.
400 Erros de validação ou os campos informados não existem no sistema.
401 Dados de acesso inválidos.
500 Erro interno do servidor.

Linguagem utilizada 🛠

CSharp

Instalando depedências 🔽

  1. Faça um clone deste repositório com:

git clone git@github.com:julialanapatto/tryitter.git

  1. Siga para o diretório: cd Tryitter.csproj

  2. Restaure as dependências: dotnet restore

  3. Rode o serviço db com o comando: docker-compose up

  4. Atualize o banco de dados: dotnet ef database update

  5. Rode a aplicação: dotnet run

7.Após rodar a aplicação, você deverá acessar através de: https://localhost:7292/swagger/index.html

Executando os testes de integração 🧪

Para rodas os testes: dotnet test

Documentação da API 📒

Para visualização do funcionamento da API, disponibilizamos os vídeos de funcionamento das rotas via Swagger, estão na seguinte pasta: /src/Tryyitter/docs ou acompanhe a execução da aplicação a seguir:

Executando a aplicação 🖥

Considerações durante o desenvolvimento 📝

Video 1: Método POST Student e obtenção do token para autorização e seu retorno no GET Student.

video1.mp4

Vídeo 2: Método GET, PUT e DELETE Student por Id do estudante e seu retorno no GET Student.

video2.mp4

Vídeo 3: Autorização e método POST Post e seu retorno no GET Post.

video3.mp4

Vídeo 4: Método PUT Post.

video.4.mp4

Vídeo 5: Método DELETE Post.

video.5.mp4

Vídeo 6: Método GET Post por Id do Estudante.

video.6.mp4

Considerações Finais

Obrigada por terem nos acompanhado até aqui.

Estamos disponíveis para feedbacks sobre melhorias no projeto e também para parcerias em novos desenvolvimentos.

About

O Tryitter é uma rede social, cujo objetivo é proporcionar um ambiente em que as pessoas estudantes poderão por meio de textos e imagens compartilhar suas experiências e também acessar posts que possam contribuir para seu aprendizado.


Languages

Language:C# 100.0%