Update documentation

pedrostanzani · Oct 24, 2024 · 0bac319 · 0bac319
1 parent a4299f1
commit 0bac319
Show file tree

Hide file tree

Showing 24 changed files with 156 additions and 12 deletions.
diff --git a/app/public/404.html b/app/public/404.html
@@ -1 +1 @@
-<!DOCTYPE html><html><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><title>404: This page could not be found</title><meta name="next-head-count" content="3"/><link rel="preload" href="/_next/static/css/d052bf94a31346bc.css" as="style"/><link rel="stylesheet" href="/_next/static/css/d052bf94a31346bc.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-42372ed130431b0a.js"></script><script src="/_next/static/chunks/webpack-d3f4805dd5665315.js" defer=""></script><script src="/_next/static/chunks/framework-64ad27b21261a9ce.js" defer=""></script><script src="/_next/static/chunks/main-8893280530365adf.js" defer=""></script><script src="/_next/static/chunks/pages/_app-008b9e96446051fb.js" defer=""></script><script src="/_next/static/chunks/pages/_error-7a92967bea80186d.js" defer=""></script><script src="/_next/static/om1NWyfMxjvl-WJ0sV2e6/_buildManifest.js" defer=""></script><script src="/_next/static/om1NWyfMxjvl-WJ0sV2e6/_ssgManifest.js" defer=""></script></head><body><div id="__next"><div style="font-family:system-ui,&quot;Segoe UI&quot;,Roboto,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div style="line-height:48px"><style>body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}</style><h1 class="next-error-h1" style="display:inline-block;margin:0 20px 0 0;padding-right:23px;font-size:24px;font-weight:500;vertical-align:top">404</h1><div style="display:inline-block"><h2 style="font-size:14px;font-weight:400;line-height:28px">This page could not be found<!-- -->.</h2></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"om1NWyfMxjvl-WJ0sV2e6","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
+<!DOCTYPE html><html><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><title>404: This page could not be found</title><meta name="next-head-count" content="3"/><link rel="preload" href="/_next/static/css/bbb13fd2a2672ac5.css" as="style"/><link rel="stylesheet" href="/_next/static/css/bbb13fd2a2672ac5.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-42372ed130431b0a.js"></script><script src="/_next/static/chunks/webpack-d3f4805dd5665315.js" defer=""></script><script src="/_next/static/chunks/framework-64ad27b21261a9ce.js" defer=""></script><script src="/_next/static/chunks/main-8893280530365adf.js" defer=""></script><script src="/_next/static/chunks/pages/_app-3983f2bd74ff3860.js" defer=""></script><script src="/_next/static/chunks/pages/_error-7a92967bea80186d.js" defer=""></script><script src="/_next/static/RxeSkf9Og8BMlhaidDNl-/_buildManifest.js" defer=""></script><script src="/_next/static/RxeSkf9Og8BMlhaidDNl-/_ssgManifest.js" defer=""></script></head><body><div id="__next"><div style="font-family:system-ui,&quot;Segoe UI&quot;,Roboto,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div style="line-height:48px"><style>body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}</style><h1 class="next-error-h1" style="display:inline-block;margin:0 20px 0 0;padding-right:23px;font-size:24px;font-weight:500;vertical-align:top">404</h1><div style="display:inline-block"><h2 style="font-size:14px;font-weight:400;line-height:28px">This page could not be found<!-- -->.</h2></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"RxeSkf9Og8BMlhaidDNl-","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
diff --git a/app/public/_next/static/RxeSkf9Og8BMlhaidDNl-/_buildManifest.js b/app/public/_next/static/RxeSkf9Og8BMlhaidDNl-/_buildManifest.js
diff --git a/...tic/om1NWyfMxjvl-WJ0sV2e6/_ssgManifest.js → ...tic/RxeSkf9Og8BMlhaidDNl-/_ssgManifest.js b/...tic/om1NWyfMxjvl-WJ0sV2e6/_ssgManifest.js → ...tic/RxeSkf9Og8BMlhaidDNl-/_ssgManifest.js
diff --git a/app/public/_next/static/chunks/812-973c33ba511491c6.js b/app/public/_next/static/chunks/812-973c33ba511491c6.js
diff --git a/app/public/_next/static/chunks/nextra-data-en-US.json b/app/public/_next/static/chunks/nextra-data-en-US.json
@@ -1 +1 @@
-{"/":{"title":"Introdução","data":{"":"Esse projeto foi desenvolvido para a disciplina de Computação em Nuvem e demonstra uma API de autenticação com JWTs (JSON Web Tokens) que foi desenvolvida com ElysiaJS, Bun e TypeScript.","tecnologias-utilizadas#Tecnologias utilizadas":"Foram utilizadas as seguintes tecnologias:\nElysiaJS: framework para construir servidores web\nBun: runtime de JavaScript e package manager\nTypeScript: linguagem de programação com tipagem estática\nPrisma: ORM para Node.js e TypeScript\nE as seguintes bibliotecas foram utilizadas para desenvolver o serviço de web scraping:\nCheerio: biblioteca para parsing de HTML\nAxios: cliente HTTP para fazer requisições web","endpoints-da-api#Endpoints da API":"A API oferece endpoints de autenticação e de consulta de dados. Acesse a documentação da API para visualizar a lista de endpoints."}}}
+{"/endpoints":{"title":"Endpoints da API","data":{"":"A API oferece endpoints de autenticação e de consulta de dados.","swagger#Swagger":"A documentação dos endpoints da API foi desenvolvida com Swagger e Scalar e pode ser acessada nesse link.","lista-de-endpoints#Lista de endpoints":"","registrar-usuário#Registrar usuário":"Endpoint: POST /registrar\nDescrição: endpoint de criação de novos usuários.","fazer-login#Fazer login":"Endpoint: POST /login\nDescrição: endpoint de autenticação para usuários existentes.\nA autenticação é realizada com email e senha. Esse endpoint retorna um token JWT que deve ser usado nas requisições ao endpoint de consulta de dados.","consultar-dados#Consultar dados":"Endpoint: GET /consulta\nDescrição: endpoint de consulta de manchetes.\nEsse endpoint retorna uma lista de manchetes da BBC. Essas manchetes são armazenadas em cache (memória) e atualizam de hora em hora."}},"/getting-started":{"title":"Instalação","data":{"":"Siga as seguintes instruções para instalar e executar o projeto.","instalação-local#Instalação local":"","download#Download":"Faça o download do arquivo compose.yaml neste link e armazene-o em um diretório vazio.","execução-com-docker-compose#Execução com Docker Compose":"Execute o comando abaixo no terminal do diretório em que o arquivo compose.yaml foi armazenado:\ndocker compose up"}},"/":{"title":"Introdução","data":{"":"Esse projeto foi desenvolvido para a disciplina de Computação em Nuvem e demonstra uma API de autenticação com JWTs (JSON Web Tokens) que foi desenvolvida com ElysiaJS, Bun e TypeScript.","tecnologias-utilizadas#Tecnologias utilizadas":"Foram utilizadas as seguintes tecnologias:\nElysiaJS: framework para construir servidores web\nBun: runtime de JavaScript e package manager\nTypeScript: linguagem de programação com tipagem estática\nPrisma: ORM para Node.js e TypeScript\nE as seguintes bibliotecas foram utilizadas para desenvolver o serviço de web scraping:\nCheerio: biblioteca para parsing de HTML\nAxios: cliente HTTP para fazer requisições web","endpoints-da-api#Endpoints da API":"A API oferece endpoints de autenticação e de consulta de dados. Acesse a documentação da API para visualizar a lista de endpoints."}}}
diff --git a/app/public/_next/static/chunks/nextra-page-map-.mjs b/app/public/_next/static/chunks/nextra-page-map-.mjs
@@ -1,6 +1,18 @@
 import meta from "../../../pages/_meta.js";
 export const pageMap = [{
   data: meta
+}, {
+  name: "endpoints",
+  route: "/endpoints",
+  frontMatter: {
+    "sidebarTitle": "Endpoints"
+  }
+}, {
+  name: "getting-started",
+  route: "/getting-started",
+  frontMatter: {
+    "sidebarTitle": "Getting Started"
+  }
 }, {
   name: "index",
   route: "/",

diff --git a/app/public/_next/static/chunks/pages/_app-008b9e96446051fb.js b/app/public/_next/static/chunks/pages/_app-008b9e96446051fb.js
diff --git a/app/public/_next/static/chunks/pages/_app-3983f2bd74ff3860.js b/app/public/_next/static/chunks/pages/_app-3983f2bd74ff3860.js
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<!DOCTYPE html><html><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><title>404: This page could not be found</title><meta name="next-head-count" content="3"/><link rel="preload" href="/_next/static/css/d052bf94a31346bc.css" as="style"/><link rel="stylesheet" href="/_next/static/css/d052bf94a31346bc.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-42372ed130431b0a.js"></script><script src="/_next/static/chunks/webpack-d3f4805dd5665315.js" defer=""></script><script src="/_next/static/chunks/framework-64ad27b21261a9ce.js" defer=""></script><script src="/_next/static/chunks/main-8893280530365adf.js" defer=""></script><script src="/_next/static/chunks/pages/_app-008b9e96446051fb.js" defer=""></script><script src="/_next/static/chunks/pages/_error-7a92967bea80186d.js" defer=""></script><script src="/_next/static/om1NWyfMxjvl-WJ0sV2e6/_buildManifest.js" defer=""></script><script src="/_next/static/om1NWyfMxjvl-WJ0sV2e6/_ssgManifest.js" defer=""></script></head><body><div id="__next"><div style="font-family:system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji";height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div style="line-height:48px"><style>body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}</style><h1 class="next-error-h1" style="display:inline-block;margin:0 20px 0 0;padding-right:23px;font-size:24px;font-weight:500;vertical-align:top">404</h1><div style="display:inline-block"><h2 style="font-size:14px;font-weight:400;line-height:28px">This page could not be found<!-- -->.</h2></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"om1NWyfMxjvl-WJ0sV2e6","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
		<!DOCTYPE html><html><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><title>404: This page could not be found</title><meta name="next-head-count" content="3"/><link rel="preload" href="/_next/static/css/bbb13fd2a2672ac5.css" as="style"/><link rel="stylesheet" href="/_next/static/css/bbb13fd2a2672ac5.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-42372ed130431b0a.js"></script><script src="/_next/static/chunks/webpack-d3f4805dd5665315.js" defer=""></script><script src="/_next/static/chunks/framework-64ad27b21261a9ce.js" defer=""></script><script src="/_next/static/chunks/main-8893280530365adf.js" defer=""></script><script src="/_next/static/chunks/pages/_app-3983f2bd74ff3860.js" defer=""></script><script src="/_next/static/chunks/pages/_error-7a92967bea80186d.js" defer=""></script><script src="/_next/static/RxeSkf9Og8BMlhaidDNl-/_buildManifest.js" defer=""></script><script src="/_next/static/RxeSkf9Og8BMlhaidDNl-/_ssgManifest.js" defer=""></script></head><body><div id="__next"><div style="font-family:system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji";height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div style="line-height:48px"><style>body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}</style><h1 class="next-error-h1" style="display:inline-block;margin:0 20px 0 0;padding-right:23px;font-size:24px;font-weight:500;vertical-align:top">404</h1><div style="display:inline-block"><h2 style="font-size:14px;font-weight:400;line-height:28px">This page could not be found<!-- -->.</h2></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"RxeSkf9Og8BMlhaidDNl-","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"/":{"title":"Introdução","data":{"":"Esse projeto foi desenvolvido para a disciplina de Computação em Nuvem e demonstra uma API de autenticação com JWTs (JSON Web Tokens) que foi desenvolvida com ElysiaJS, Bun e TypeScript.","tecnologias-utilizadas#Tecnologias utilizadas":"Foram utilizadas as seguintes tecnologias:\nElysiaJS: framework para construir servidores web\nBun: runtime de JavaScript e package manager\nTypeScript: linguagem de programação com tipagem estática\nPrisma: ORM para Node.js e TypeScript\nE as seguintes bibliotecas foram utilizadas para desenvolver o serviço de web scraping:\nCheerio: biblioteca para parsing de HTML\nAxios: cliente HTTP para fazer requisições web","endpoints-da-api#Endpoints da API":"A API oferece endpoints de autenticação e de consulta de dados. Acesse a documentação da API para visualizar a lista de endpoints."}}}
		{"/endpoints":{"title":"Endpoints da API","data":{"":"A API oferece endpoints de autenticação e de consulta de dados.","swagger#Swagger":"A documentação dos endpoints da API foi desenvolvida com Swagger e Scalar e pode ser acessada nesse link.","lista-de-endpoints#Lista de endpoints":"","registrar-usuário#Registrar usuário":"Endpoint: POST /registrar\nDescrição: endpoint de criação de novos usuários.","fazer-login#Fazer login":"Endpoint: POST /login\nDescrição: endpoint de autenticação para usuários existentes.\nA autenticação é realizada com email e senha. Esse endpoint retorna um token JWT que deve ser usado nas requisições ao endpoint de consulta de dados.","consultar-dados#Consultar dados":"Endpoint: GET /consulta\nDescrição: endpoint de consulta de manchetes.\nEsse endpoint retorna uma lista de manchetes da BBC. Essas manchetes são armazenadas em cache (memória) e atualizam de hora em hora."}},"/getting-started":{"title":"Instalação","data":{"":"Siga as seguintes instruções para instalar e executar o projeto.","instalação-local#Instalação local":"","download#Download":"Faça o download do arquivo compose.yaml neste link e armazene-o em um diretório vazio.","execução-com-docker-compose#Execução com Docker Compose":"Execute o comando abaixo no terminal do diretório em que o arquivo compose.yaml foi armazenado:\ndocker compose up"}},"/":{"title":"Introdução","data":{"":"Esse projeto foi desenvolvido para a disciplina de Computação em Nuvem e demonstra uma API de autenticação com JWTs (JSON Web Tokens) que foi desenvolvida com ElysiaJS, Bun e TypeScript.","tecnologias-utilizadas#Tecnologias utilizadas":"Foram utilizadas as seguintes tecnologias:\nElysiaJS: framework para construir servidores web\nBun: runtime de JavaScript e package manager\nTypeScript: linguagem de programação com tipagem estática\nPrisma: ORM para Node.js e TypeScript\nE as seguintes bibliotecas foram utilizadas para desenvolver o serviço de web scraping:\nCheerio: biblioteca para parsing de HTML\nAxios: cliente HTTP para fazer requisições web","endpoints-da-api#Endpoints da API":"A API oferece endpoints de autenticação e de consulta de dados. Acesse a documentação da API para visualizar a lista de endpoints."}}}