API do sistema de gerenciamento de clínicas médicas.

O projeto ainda está em desenvolvimento e as próximas atualizações estarão voltadas para as seguintes tarefas:

• Implementação do módulo de Autenticação;
• Implementação do módulo de Usuários;
• Implementação do módulo de Gerenciar Perfil;
• Implementação do módulo de Convênios;
• Implementação do módulo de Especialidades;
• Implementação do módulo de Gerenciar Tenants;
• Implementação do módulo de Pacientes;
• Implementação do módulo de Endereços;
• Implementação do módulo de Gerenciar Consultas (visão do médico);
• Implementação do módulo de Recuperar Senha;
• Implementação do módulo de Médicos;
• Implementação do middleware de Permissões;
• Implementação do módulo de Relatórios;
• Implementação da Configuração de Agenda;
• Implementação da Agenda;
• Implementação de Arquivos de Consultas;

Estes são os requisitos para que este projeto execute corretamente em sua máquina:

• Você tem instalado em sua máquina Node.js v16.13.2. Utilize o comando node --version para checar a sua versão. Você também pode utilizar o nvm para alternar entre as versões do Node.js em sua máquina;
• Você tem instalado em sua máquina um gerenciador de pacotes para Node.js (yarn ou npm);

Para configurar o MedicalSystem API, siga estas etapas:

1. Clone o repositório e acesse a pasta com os arquivos do projeto;
2. Execute o comando yarn ou npm install;
3. No diretório do projeto raíz do projeto, crie um arquivo .env e configure as variáveis de ambiente necessárias. Utilize como base o arquivo .env.example;

Para executar a API, siga estas etapas:

1. Dentro da pasta do projeto, execute no terminal o script de start yarn dev ou npm dev;

O projeto possui duas branches principais:

1. dev: branch onde está o código em desenvolvimento;
2. master: branch principal onde está o código em produção;

Os commits devem acontecer em branches separadas (quando há mais de um colaborador) e então devem ser mergeados na branch dev para que só então sejam mergeados na branch master.

Este projeto utiliza a biblioteca Japa, indicada para testes pela documentação oficial do framework AdonisJS. Até o momento o projeto conta com testes de Controllers e Services. Siga os passos abaixo para executá-los:

1. Entre na pasta do projeto e siga os passos de configuração da aplicação caso ainda não o tenha feito.
2. No terminal, execute o comando yarn test para executar os testes do projeto. Caso queira executar os testes e ainda ver a sua cobertura de código, execute o comando yarn coverage.
3. Caso queira executar os casos de testes de um único arquivo, execute o comando yarn test ou yarn coverage seguido do caminho do arquivo. Por exemplo: yarn coverage tests/user/UserController.spec.ts.

Abaixo estão listados os colaboradores que atuam neste projeto:

Pedro Rubinger

Esse projeto ainda não está sob licença.