Tryitter - Projeto Final Aceleração em C# .NET

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

🔍 Tecnologias utilizadas

• Construção da API - ASP.NET
  
• Banco de dados SQL Server
  
• Autenticação - JWT
  
• Testes - Fluent Assertions e xUnit.net
  
• Deploy - Azure
  

📋 Execute o projeto em sua máquina

Clone o repositório:

git clone git@github.com:Ondion/Tryitter.git
cd src/triytter
dotnet restore
dotnet run

🕵 Diagrama UML da API

🧪 Executando os testes

Entre na pasta dos testes cd src/triytter.Test e rode o comando:

dotnet test

Testes de cobertura:

Na pasta dos testes cd src/triytter.Test rode o comando:

dotnet test --collect:"XPlat Code Coverage" --settings coverlet.runsettings 

Para ver os resultados da cobertura no formato HTML,instale o reportgenerator-globaltool com o seguinte comando:

dotnet tool install --global dotnet-reportgenerator-globaltool --version 4.8.6

E rode o seguinte comando na pasta criada pelo Code Coverage para armazenar os resultados:

reportgenerator "-reports:coverage.cobertura.xml" "-targetdir:coveragereport" -reporttypes:Html

Então visualize os resultados do arquivo index.html no navegador

🎯 Cobertura dos testes

O testes deste projeto contemplaram uma cobertura de 98.3% da linhas.
As linhas não cobertas tratam de linhas de configurações.

🔨 Deploy

O deploy da aplicação foi executado utilizando o Microsoft Azure
Os links do deploy são:

Backend

https://tryitter.azurewebsites.net/

Banco de dados:

https://tryitter.database.windows.net

🔎 Documentação da API

🏃 Students 🏃

  GET /Students 

 GET /Student/:id

  GET /Student/Name/

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do estudante.

  POST /Student

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do estudante.
email	string	Obrigatório. Email do estudante.
Password	number	Obrigatório. Senha da conta criada.
status	number	Obrigatório. status do estudante.

  POST /Login 

Parâmetro	Tipo	Descrição
email	string	Obrigatório. Seu email.
password	string	Obrigatório. Sua senha.
Authorization	string	Obrigatório. 🔑 Token do login deve ser passado no header.

❗❗ Retorna Token

  PATCH /Student/:id

Parâmetro	Tipo	Descrição
name	string	Obrigatório. : Nome do estudante.
email	string	Obrigatório. : Email do estudante.
password	number	Obrigatório. :Senha da conta criada.
status	number	Obrigatório. status do estudante.
Authorization	string	Obrigatório. 🔑 Token do login deve ser passado no header.

  DELETE/Student/:id

| Authorization | string | Obrigatório. 🔑 Token do login deve ser passado no header. |
❗❗ Ao deletar um estudanten todos os seus post criados são deletados.

📄 Posts 📄

  GET /Post

  GET /Post/:id

  GET /Post/Student/:id

  GET /Post/Last/Student/:id

  GET /Post/StudentName

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do estudante.

  /Post/Last/StudentName

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do estudante.

  POST /Post

Parâmetro	Tipo	Descrição
content	string	Obrigatório. Texto da postagem.
image	string	Imagem a ser postada
studentEmail	number	Obrigatório. Email do estudante
Authorization	string	Obrigatório. 🔑 Token do login deve ser passado no header.

  PUT /Post/:id 

Parâmetro	Tipo	Descrição
content	string	Obrigatório. Texto da postagem.
image	string	Imagem a ser postada
studentEmail	number	Obrigatório. Email do estudante
Authorization	string	Obrigatório. 🔑 Token do login deve ser passado no header.

  DELETE /Post/:id 

Parâmetro	Tipo	Descrição
studentEmail	number	Email do estudante
Authorization	string	Obrigatório. 🔑 Token do login deve ser passado no header.

✏️ Projeto Executado por:

Tamires Sousa GitHub | Linkedin
Fábio Xavier GitHub | Linkedin