https://github.com/luissimas/pooa-grupos-academicos

Sistema de gerenciamento de grupos acadêmicos.
https://github.com/luissimas/pooa-grupos-academicos

Last synced: about 1 month ago
JSON representation

Sistema de gerenciamento de grupos acadêmicos.

• Host: GitHub
• URL: https://github.com/luissimas/pooa-grupos-academicos
• Owner: luissimas
• Created: 2022-07-07T11:06:02.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-23T11:21:45.000Z (about 2 years ago)
• Last Synced: 2023-05-20T18:28:36.026Z (over 1 year ago)
• Language: TypeScript
• Size: 321 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

README

        
* Gerenciamento de grupos acadêmicos

Sistema de gerenciamento de grupos acadêmicos desenvolvido no decorrer da disciplina de Programação Orientada a Objetos Avançada.

** Requisitos do sistema

** Desenvolvimento

*** Ambiente

*** Arquitetura

** Uso

A rota base para acessar os recursos da API é [[https://pooa-grupos-academicos.herokuapp.com/]]. A documentação completa está disponível em: [[https://pooa-grupos-academicos.herokuapp.com/docs]].

** Instalação local

Para instalar e rodar o servidor localmente, é necessário primeiro clonar este repositório.

#+begin_src shell

git clone [email protected]:luissimas/pooa-grupos-academicos.git && cd pooa-grupos-academicos

#+end_src

Após isso, é possível instalar as dependências usando o comando =yarn=. Caso você não tenha o =yarn= instalado, basta seguir as [[https://yarnpkg.com/getting-started/install][instruções de instalação]].

#+begin_src shell

yarn

#+end_src

Para iniciar o servidor basta utilizar o comando =yarn start=.

#+begin_src shell

yarn start

#+end_src

Agora, basta acessar a documentação da API através do seguinte link: [[http://localhost:3333/docs]].

** Autenticação

Para utilizar o serviço de autenticação do sistema, basta utilizar as rotas de login e cadastro disponíveis na [[https://pooa-grupos-academicos.herokuapp.com/docs][documentação]]. Os tokens de autenticação gerados podem ser validados utilizando a chave pública:

#+begin_example

-----BEGIN RSA PUBLIC KEY-----

MIGJAoGBAJ/e4bsASz64EGK9Jt5m0njW/mghAe4u/QoI3YTc4U6F8ULHzCrMZ6mz

tut+84Rcwe4ufpVfYx4Nd4zGwCoxIo9SijXaIA+1zY+l+XISlUuDwilJqla+sSrG

ZcrBT1hZCw0hN0aDNyByMkxAekicrkJAWbOwe5rldIBxNUKJ+qdBAgMBAAE=

-----END RSA PUBLIC KEY-----

#+end_example