Semana 8 - Página do perfil de Aluno e Atualização do README.

README.md

@@ -4,122 +4,33 @@
 ## 📝 Sumário
 
 - [Sobre](#sobre)
-- [Iniciando](#iniciando)
-- [Modo de uso](#uso)
-- [Endpoints da API](#endpoints)
+- [Instruções - Backend](./backend/README.md)
+- [Endpoints da API](./backend/README.md#endpoints)
+- [Instruções - Frontend](./frontend/README.md)
+- [Observações](#observacoes)
+- [Screenshots](#screenshots)
 
 ## 🧐 Sobre <a name = "sobre"></a>
 
 ### Qual a motivação?
 A ideia do GitRadar surgiu da necessidade dos professores de gerarem relatórios de utilização da plataforma do github pela turma da disciplina. Fazendo assim um maior acompanhamento e monitorar mais de perto alunos que estejam com poucas interações com a plataforma, por exemplo.
+
 ### Objetivo do projeto <br>
 Ser uma plataforma no qual os professores poderão se cadastrar e criar turmas. Os alunos cadastrados no sistemas poderão se linkar com a turma através de um QRCODE gerado pelo professor. <br>
 Através dessas turmas, os professores poderão gerar relatórios do estado da turma. Trazendo dados como Engajamento médio com a plataforma e alunos com baixo engajamento. Além de poder traçar um perfil médio da turma.
 
-## 🏁 Iniciando <a name = "iniciando"></a>
-
-Você pode clonar o respositório com o git, com o seguinte comando:
-```
-git clone https://github.com/Guardians-DSC/GitRadar.git
-```
-
-### Pré-requisitos
-
-Você precisará de NodeJS e Yarn (para facilitar o processo) no seu computador. <br>
-- [NodeJS](https://nodejs.org/en/download/) <br>
-- [Yarn](https://yarnpkg.com/getting-started/install)
-
-### Instalando
-
-No terminal, abra a pasta do projeto.
-```
-cd GitRadar
-```
-Então, digite:
-```
-yarn
-```
-Pronto! Tudo está configurado para você começar a usar o projeto.
-
-
-## 🚀 Modo de uso <a name = "uso"></a>
+## ✅ Observações <a name = "observacoes"></a>
+O projeto contém um repositório para o Backend e outro para o Frontend da aplicação. Os README's específicos de cada repositório podem ser encontrados em suas respectivas pastas. Lá você encontrará as instruções de uso e desenvolvimento.
+- [Ir para o README do Backend](./backend/README.md)
+- [Ir para o README do Frontend](./frontend/README.md)
 
-Você pode iniciar o servidor local de desenvolvimento, com o seguinte comando:
-```
-yarn dev:server
-```
+## 📸 Screenshots <a name = "screenshots"></a>
 
-# 🔎 Endpoints da API <a name = "endpoints"></a>
+#### Dashboard de uma Turma:
+![dashboard](https://user-images.githubusercontent.com/40612788/98311926-54f4cf80-1faf-11eb-8962-c1a7a887981f.png)
 
-## Obter perfil:
-```
-GET /user/:username
-```
-Use essa rota para obter informações sobre o perfil de determinado usuário, basta substituir o parâmetro ":username" da rota pelo usuário do github correspondente, você deve receber uma resposta no seguinte modelo:
-```json
-{
-  "github_login": "davigsousa",
-  "avatar_url": "https://avatars0.githubusercontent.com/u/40612788?v=4",
-  "repositories": [
-    {
-      "name": "algorithms",
-      "full_name": "davigsousa/algorithms",
-      "description": "Some useful algorithms (Still learning and updating more).",
-      "html_url": "https://github.com/davigsousa/algorithms",
-      "created_at": "2020-05-27T14:50:25Z",
-      "language": "C++"
-    },
-    {
-      "name": "doeteca",
-      "full_name": "davigsousa/doeteca",
-      "description": "A Frontend for a Conceptual Project named Doeteca. Online on: https://doeteca.netlify.app/",
-      "html_url": "https://github.com/davigsousa/doeteca",
-      "created_at": "2020-02-17T22:01:18Z",
-      "language": "JavaScript"
-    },
-  ],
-  "top_language": "JavaScript",
-  "top_5_languages": [
-    "JavaScript",
-    "Python",
-    "C++",
-    "CSS",
-    "TypeScript"
-  ]
-}
-```
+#### Perfil de Estudante 1/2:
+![profile](https://user-images.githubusercontent.com/40612788/98311933-5aeab080-1faf-11eb-85a6-6929cd482035.png)
 
-## Obter relatório do dia atual:
-```
-GET /user/daily/:username
-```
-Use essa rota para obter informações de interações de determinado usuário no dia atual, basta substituir o parâmetro ":username" da rota pelo usuário do github correspondente, você deve receber uma resposta no seguinte modelo:
-```json
-{
-  "new_forks": 0,
-  "new_issues": 0,
-  "new_prs": 4,
-  "new_stars": 0,
-  "new_repositories": 0,
-  "new_interactions": 4,
-  "new_commits": 32,
-  "commits": [
-    {
-      "repository": {
-        "id": 289791710,
-        "name": "Guardians-DSC/GitRadar",
-        "url": "https://api.github.com/repos/Guardians-DSC/GitRadar"
-      },
-      "message": "initial Service structure created"
-    },
-    {
-      "repository": {
-        "id": 293942092,
-        "name": "davigsousa/GitRadar",
-        "url": "https://api.github.com/repos/davigsousa/GitRadar"
-      },
-      "message": "Merge pull request #1 from davigsousa/develop\n\nCriação da Api e Criação do Profile Service"
-    }
-  ]
-}
-```
+#### Perfil de Estudante 2/2:
+![profile2](https://user-images.githubusercontent.com/40612788/98311936-5d4d0a80-1faf-11eb-8268-2b98dd3623cf.png)