FreeProject5/citas_medicas_backend

Administración de citas médicas

Se ha realizado una aplicación web para administrar citas médicas online la cual consta de 2 partes:

• Backend -> REST API citas médicas
• Frontend -> App citas médicas - Repositorio

Este repositorio contiene el código backend del proyecto con el que se puede realizar múltiples tareas como gestionar datos, autenticación y procesamiento de solicitudes de:

1. Pacientes. 🙋🏻‍♂️🙋🏻‍♀️
2. Doctores. 🧑🏻‍⚕️
3. Citas médicas. 🕞
4. Especialidades. 🩺
5. Horarios médicos. 📅

Instalación y configuración 🛠️

• Instalar las depedencias del proyecto

  npm install

Supabase 💾

Se ha implementado Supabase como base de datos online, por lo tanto se requiere:

• Crear un proyecto en su web.
• Configurar las tablas de la BD y establecer RLS disabled.
• Copiar los valores de PROJECT_URL y API_KEY para usar en nuestro proyecto.

Variables de entorno 🔑

• Configurar las variables de entorno en el archivo .env en la raíz del proyecto con los parámetros:

  SUPABASE_PROJECT_URL = "https://link-de-ejemplo.supabase.co";
  SUPABASE_API_KEY = "mykeysupabaseproject";
  SECRET_KEY = "mysecretkey";
  ACCOUNT_SID = "twilioaccountsid";
  AUTH_TOKEN= "twilioauthtoken";

  Se recomienda encriptar el valor de SECRET_KEY con la función crypto de Node.

  Ingresar al CLI de Node en el terminal

   node

  Ejecutar

  require("crypto").randomBytes(64).toString("hex")

  Esto nos dará una clave la cual usaremos como SECRET_KEY

Instalación y configuración de JEST

npm i jest -D

• En package.json scripts poner jest

npm i --save-dev @types/jest

jest solo me permite usar require, entonces para poder usar import ,usaré este comando:

npm install --save-dev babel-jest @babel/core @babel/preset-env

Para usar typescript

npm install --save-dev @babel/preset-typescript

npm i ts-jest -D

Aquí se instala el coverage dependiendo de la configuración cuando ejecutemos el siguiente comando. También se configura jest

npx jest --init

Ejecutar el proyecto

npm run dev

Funcionamiento

Hay rutas protegidas con middleware que requieren enviar un token de verificacion en el Headers, el cual se obtiene al momento de hacer login de un usuario.

Pacientes 🙋🏻‍♂️🙋🏻‍♀️

• Para crear usuarios pacientes enviar los datos en el body con formato JSON. De la misma manera se envia algunos o todos los datos del usuario que desea actualizarlos al endpoint correspondiente.

  {
    "firstname": "John",
    "lastname": "Doe",
    "phone": "987654321",
    "age": 30,
    "email": "johndoe@gmail.com",
    "password": "12345678"
  }

• Endpoints

  1. http://localhost:6005/api/v1/patient --> Crear usuarios pacientes (POST) ✔️

  2. http://localhost:6005/api/v1/patient/login --> Login de usuarios, enviar email y password (POST) ✔️

     Esto genera un token que se usará para acceder a las rutas protegidas

  3. http://localhost:6005/api/v1/patient --> Obtener todos los usuarios (GET) 🗒️

  4. http://localhost:6005/api/v1/patient/id --> Obtener un usuario por id enviando el token (GET) 🗒️

  5. http://localhost:6005/api/v1/patient/id --> Actualizar usuario por id enviando el token (PUT) 🔃

  6. http://localhost:6005/api/v1/patient/id --> Eliminar un usuario por id enviando el token (DELETE) ❌

Doctores 🧑🏻‍⚕️

• Para crear usuarios doctores enviar los datos en el body con formato JSON. De la misma manera se envia algunos o todos los datos del doctor que desea actualizarlos al endpoint correspondiente.

  {
    "firstname": "John",
    "lastname": "Doe",
    "email": "johndoe@gmail.com",
    "password": "12345678"
  }

• Endpoints

  1. http://localhost:6005/api/v1/doctor --> Crear usuarios doctores (POST) ✔️

  2. http://localhost:6005/api/v1/doctor/login_doctor --> Login de doctores, enviar email y password (POST) ✔️

     Esto genera un token que se usará para acceder a las rutas protegidas

  3. http://localhost:6005/api/v1/doctor --> Obtener todos los doctores (GET) 🗒️

  4. http://localhost:6005/api/v1/doctor/id --> Obtener un doctor por id (GET) 🗒️

  5. http://localhost:6005/api/v1/patient/id --> Actualizar doctor por id enviando el token (PUT) 🔃

  6. http://localhost:6005/api/v1/patient/id --> Eliminar un doctor por id enviando el token (DELETE) ❌

Citas médicas 🕞

• Para crear citas médicas enviar los datos en el body con formato JSON. De la misma manera se envia algunos o todos los datos de la cita que que se quiere actualizar al endpoint correspondiente.

  {
    "id_patient": 1,
    "id_specialtie": 2,
    "id_doctor": 4,
    "id_schedule": 3,
    "checkup_date": "aaaa-mm-dd",
    "checkup_time": "hh:mm:ss"
  }

• Endpoints

  1. http://localhost:6005/api/v1/checkup --> Crear citas médicas (POST) ✔️

  2. http://localhost:6005/api/v1/checkup --> Obtener todas las citas médicas (POST) ✔️

  3. http://localhost:6005/api/v1/checkup/id --> Actualizar doctor por id enviando el token (PUT) 🔃

  4. http://localhost:6005/api/v1/checkup/id --> Eliminar un doctor por id enviando el token (DELETE) ❌

  5. http://localhost:6005/api/v1/checkup/bypatient/id --> Obtener citas médicas de un paciente por id (GET) 🗒️

  6. http://localhost:6005/api/v1/checkup/bydoctor/id --> Obtener citas médicas programadas de un doctor por id (GET) 🗒️

  7. http://localhost:6005/api/v1/checkup/data --> Obtener citas médicas programadas de un doctor por id (GET) 🗒️

Especialidades 🩺

• Para crear especialidades enviar los datos en el body con formato JSON. De la misma manera se envia algunos o todos los datos de la especialidad que que se quiere actualizar al endpoint correspondiente.

  {
    "name": "Cardiología"
  }

• Endpoints

  1. http://localhost:6005/api/v1/specialties --> Crear especialidades (POST) ✔️

  2. http://localhost:6005/api/v1/specialties --> Obtener todas las especialidades (GET) ✔️

  3. http://localhost:6005/api/v1/specialties/id --> Eliminar una especialidad por id (DELETE) ❌

  4. http://localhost:6005/api/v1/specialties/update/id --> Actualizar una especialidad por id (PUT) 🗒️

  5. http://localhost:6005/api/v1/specialties/byspecialty/id --> Obtener doctores por especialidad (GET) 🗒️

Horarios médicos 📅

• Para crear horarios médicos enviar los datos en el body con formato JSON.

  {
    "id_doctor": 1,
    "date": "2023-02-06",
    "start_time": "09:00:00-05",
    "end_time": "16:00:00-05",
  }

• Endpoints

  1. http://localhost:6005/api/v1/doctor/RegistrationHorario --> Crear horarios médicos (POST) ✔️

  2. http://localhost:6005/api/v1/doctor/findAll/Schedule --> Obtener todos los horarios médicos (GET) ✔️

  3. http://localhost:6005/api/v1/doctor/findAll_schedule/id --> Obtener un horario médico por id (GET) 🗒️