• Projeto
• Features
• Começando
• Instalação Comum
  • Configuração
  • Iniciando o projeto
  • Script do banco
• Utilizando o docker
  • Iniciando os containers
  • O banco
  • Encerrando o docker
  • Php myadmin
• Documentação
  • Swagger
  • Local

Monitoria voluntária - Backend

Projeto

Este repositório refere-se ao backend do aplicativo de monitorias criado pela fronteira tec. É possível encontrar o repositório do aplicativo aqui.

IMPORTANTE: Executar apenas este repositório lhe dara acesso a uma API e não ao aplicativo.

Features

As principais features do projeto são:

• Criação de novos usuários;
• Login utilizando o idUFFS;
• Gerenciar monitorias;
• Inscrever-se como monitor;
• Inscrever-se em uma monitoria;
• Gerenciar usuário
• Geração de QrCode unico por usuário
• Confirmação de presença em monitoria

Começando

Caso tenha interesse em rodar localmente o projeto, siga os passos abaixo. A maneira mais simples é utizando o docker.

Instalação Comum

Instale o Yarn ou npm em seu computador, após isso utilize:

    yarn install
    # ou 
    npm i

Configuração

Altere o arquivo development.env preenchendo as variáveis de acordo com sua configuração local do mariadb.

Iniciando o projeto

Para rodar o programa em modo de desenvolvimento use:

    yarn start:dev
    # ou
    npm run start:dev

Dê preferencia ao yarn caso possua ambos ou caso venha a ter que instalar um dos dois.

PS: O banco de dados também deve ser instalado

Script do banco

Pode-se encontrar o plugin de instalação do banco de dados em db.sql.
Juntamente com o banco existe um arquivo com dados fictícios que podem ser utuilizados para desenvolvimento em dummyData.sql.

O diagrama do banco pode ser encontrado em diagrama.png

Utilizando o docker

Tenha certeza de que o docker esta instalado e rodando, assim como o docker-compose.

Iniciando os containers

Utilize:

    docker-compose up ## adicione -d caso queira rodar em segundo plano
    # ou 
    npm run dup

Importante:
Na primeira inicialização o container do mariadb pode demorar um pouco para completar a inicialização. Durante este processo, mesmo que o servidor esteja funcionando, não sera possível acessar o banco.

O banco

Por padrão, o usuário do banco de dados e a senha são:
user: root
password: 123

Encerrando o docker

Caso iniciado com a flag -d pode-se encerrar o container utilizando:

    docker-compose down 
    # ou 
    npm run ddown

Php myadmin

Uma das imagens contidas neste repositório é a do phpmyadmin, podendo acessar o mesmo clicando aqui ou acessando:
http://localhost

Endpoints

Por padrão, a porta utilizada no projeto é a 3000, mas pode ser alterada em development.env

Ou seja, acessar a api requer:

http://localhost:3000

Swagger

É possível acessar a documentação a partir desta url. É altamente recomendável que utilize este link e não o local.

Local

A documentação também esta disponível localmente em: https://fronteiratec.github.io/tori-api