Proyecto-ISPP / FISIOFIND

Fisio Find: The specialized online consultation platform for physiotherapists

Fisio Find

The specialized online consultation platform for physiotherapists

Table of Contents

• Overview
• Features
• Project Structure
  • Project Index
• Local Deployment
  • Prerequisites
  • Installation
  • Database Setup
  • Usage
• Project Roadmap
  • Sprint 1: Core Use Cases
  • Sprint 2: Tools & Payment
  • Sprint 3: Extras & Testing
• Contributing
• License
• Acknowledgments

---

Overview

Fisio Find is a specialized online consultation platform designed to connect physiotherapists with patients. The platform streamlines the process of finding and booking physiotherapy services, while providing professionals with tools to manage their practice efficiently.

---

Features

• 📅 Appointment Management

  • Interactive calendar system
  • Automated scheduling
  • Reminder notifications
  • Real-time availability updates

• 💻 Virtual Consultations

  • High-quality video calls
  • Secure chat system
  • File sharing capabilities
  • Session recording options

• 💰 Payment Integration

  • Secure payment processing
  • Multiple payment methods
  • Automated invoicing
  • Subscription management

• 📊 Professional Tools

  • Patient record management
  • Treatment tracking
  • Progress reports
  • Easy-to-use upload video interface

---

Project Structure

└── FISIOFIND/
    ├── .github
    │   ├── ISSUE_TEMPLATE
    │   ├── PULL_REQUEST_TEMPLATE.md
    │   └── workflows
    ├── README.md
    ├── backend
    │   ├── .env.example
    │   ├── fisio_find
	│ 	│   ├── appointment
	│ 	│   ├── appointment_rating
	│ 	│   ├── files
	│ 	│   ├── fisio_find
	│ 	│   ├── gestion_survey
	│ 	│   ├── guest_session
	│ 	│   ├── payment
	│ 	│   │	├── management/commands
	│ 	│   │	└── utils
	│ 	│   ├── questionnaire
	│ 	│   ├── ratings
	│ 	│   ├── terms
	│ 	│   ├── treatments
	│ 	│   │	└── management/commands
	│ 	│   ├── users
	│ 	│   └── videocall
    │   ├── requirements.txt
    │   └── run-backend.ps1
    ├── docs
    │   ├── .DS_Store
    │   ├── .backgrounds
    │   ├── .img
    │   ├── 01_organization
    │   ├── 02_planification
    │   ├── 03_reports
    │   ├── 04_monitoring
    │   ├── 05_knowledge_base
    │   ├── 06_terms
    │   ├── Devising a Project
    │   ├── SPRINT 1
    │   ├── SPRINT 2
    │   ├── build-pdf-examples.sh
    │   ├── eisvogel.latex
    │   └── templates
    └── frontend
        ├── README.md
        ├── app
		│   ├── account/delete/confirm/[token]
		│   ├── advanced-search
		│   ├── appointments/create/[id]
		│   ├── confirm-alternative/[token]
		│   ├── confirm-appointment/[token]
		│   ├── login
		│   ├── logout
		│   ├── modelo
		│   ├── my-appointments
		│   ├── patient-management
		│	│   ├── follow-up
		│	│   │	├── [id]
		│	│   │	│	├── files
		│	│   │	│	├── sessions
		│	│   │	│	│	└── [sessionId]
		│	│   │	│	└── videos
		│	│   └── profile
		│   ├── permissions-error
		│   ├── physio-management
		│	│   ├── [id]/exercises
		│	│   ├── balance
		│	│   ├── follow-up
		│	│   │	├── [id]
		│	│   │	│	├── files
		│	│   │	│	├── sessions
		│	│   │	│	│	└── [sessionId]
		│	│   │	│	└── videos
		│	│   │	└──	 components
		│	│   └── profile
		│   ├── questionnaires
		│   ├── register
		│	│   ├── patient
		│	│   ├── physio
		│	│   └── verified/[token]
		│   ├── terms
		│   ├── unsubscribe
		│   ├── videocalls
		│	│   ├── [roomCode]
		│	│   ├── css
		│	│   ├── end
		│	│   ├── hooks
		│	│   ├── tools
		│	│   │	├── body-highlighter
		│	│	│   │	├── assests
		│	│	└── └──	└── components
		│   ├── globals.css
		│   ├── layout.tsx
		│   ├── not-found.tsx
		│   └── page.tsx
        ├── components
		│   └── ui
        ├── context
        ├── lib
        ├── public
		│   ├── images
		│   └── pdfs/06_terms
        ├── services
        ├── static
		│   ├── images
		│   │ 	├── body-regions
		│   └── └── exercise-types
        └── utils

Project Index

FISIOFIND/

• .github

  • ISSUE_TEMPLATE – Plantillas para crear incidencias
  • PULL_REQUEST_TEMPLATE.md – Plantilla para solicitudes de extracción
  • workflows – Configuración de flujos de trabajo para GitHub Actions
• README.md – Documentación principal del proyecto
• backend

  • .env.example – Archivo de entorno de ejemplo
  • fisio_find

    • appointment – Gestión de citas
    • appointment_rating – Valoraciones de citas
    • files – Gestión de archivos
    • fisio_find – Configuración principal del proyecto Django
    • gestion_survey – Gestión de encuestas
    • guest_session – Sesiones de invitados
    • payment

      • management/commands – Comandos personalizados
      • utils – Utilidades del módulo de pagos
    • questionnaire – Cuestionarios
    • ratings – Valoraciones generales
    • terms – Términos y condiciones
    • treatments

      • management/commands – Comandos personalizados
    • users – Gestión de usuarios
    • videocall – Videollamadas
  • requirements.txt – Dependencias del backend
  • run-backend.ps1 – Script de ejecución del backend
• docs

  • .DS_Store – Archivo interno de macOS
  • .backgrounds – Recursos visuales
  • .img – Imágenes de documentación
  • 01_organization – Organización del proyecto
  • 02_planification – Planificación
  • 03_reports – Informes
  • 04_monitoring – Monitoreo
  • 05_knowledge_base – Base de conocimiento
  • 06_terms – Términos documentados
  • Devising a Project – Diseño del proyecto
  • SPRINT 1 – Documentación del Sprint 1
  • SPRINT 2 – Documentación del Sprint 2
  • build-pdf-examples.sh – Generación de PDFs
  • eisvogel.latex – Plantilla LaTeX
  • templates – Plantillas de documentación
• frontend

  • README.md – Documentación del frontend
  • app

    • account – Gestión de cuentas
      • delete – Eliminación de cuenta
        • confirm – Confirmación
          • [token] – Token de confirmación
    • advanced-search – Búsqueda avanzada
    • appointments – Gestión de citas
      • create – Crear cita
        • [id] – Cita por ID
    • confirm-alternative – Confirmación alternativa
      • [token]
    • confirm-appointment – Confirmación de citas
      • [token]
    • login – Inicio de sesión
    • logout – Cierre de sesión
    • modelo – Modelo anatómico
    • my-appointments – Mis citas

Local Deployment

Prerequisites

Before getting started with FISIOFIND, ensure your runtime environment meets the following requirements:

• Programming Language: Python
• Package Manager: Npm, Pip
• Database: Postrgres

Installation

Install FISIOFIND using one of the following methods:

1. Clone the FISIOFIND repository:

❯ git clone https://github.com/Proyecto-ISPP/FISIOFIND

1. Navigate to the project directory:

❯ cd FISIOFIND

1. Install the project dependencies:

Using pip  

First, create and activate a Python virtual environment in the backend directory:

❯ cd backend
❯ python -m venv venv
❯ source venv/bin/activate

Then we proceed to install the dependencies:

❯ pip install -r requirements.txt

Using npm  

We now install the frontend framework dependencies in the frontend directory:

❯ cd ../fronend
❯ npm install

Database Setup

To set up the database for FISIOFIND, follow these steps:

1. Create the Database:

   Ensure you have PostgreSQL installed and running. Then, create a new database named fisiofind:

   ❯ psql -U postgres
   postgres=# CREATE DATABASE fisiofind;
   postgres=# \q

2. Configure Environment Variables:

   Copy the .env.example file to create a new .env file in the backend directory:

   ❯ cd backend
   ❯ cp .env.example .env

   Open the .env file and update the database configuration with your PostgreSQL credentials:

   DATABASE_NAME=fisiofind
   DATABASE_USER=your_postgres_user
   DATABASE_PASSWORD=your_postgres_password
   DATABASE_HOST=localhost
   DATABASE_PORT=5432

   Replace your_postgres_user and your_postgres_password with your actual PostgreSQL username and password.

3. Apply Migrations:

   With the virtual environment activated, apply the database migrations to set up the initial schema:

   ❯ python manage.py makemigrations
   ❯ python manage.py migrate

4. Create a Superuser:

   Create a superuser account to access the Django admin panel:

   ❯ python manage.py createsuperuser

   Follow the prompts to set up the superuser credentials.

Once these steps are completed, your database should be set up and ready for use with FISIOFIND.

Usage

The first time the project is locally deployed, we need to create a .env filed in the backend directory according to the .env.example file.

To run the backend server, follow these steps on the backend directory and with the venv activated:

❯ cd .\fisio_find
❯ python .\manage.py makemigrations
❯ python .\manage.py migrate
❯ python .\manage.py runserver

Additionaly, the first time the project is locally deployed, we need to create a superuser to access the admin panel:

❯ python.\manage.py createsuperuser

After the local backend server is running, we can run the frontend server in a new terminal window:

Using npm  

❯ cd ../../fronted
❯ npm run dev

---

Project Roadmap

Sprint 1: Core Use Cases

• Core-1: Team training and onboarding completed.
• Core-2: Basic user management system implemented.
• Core-3: Core use cases functionality implemented.
• Core-4: Aesthetic and accessible landing page deployed.

Sprint 2: Tools & Payment

• Tools-1: Payment and monetization system developed.
• Tools-2: Physiotherapist tools implemented.

Sprint 3: Extras & Testing

• Extra-1: Additional application features developed.
• Extra-2: User support tools implemented.
• Extra-3: Comprehensive application testing completed.

PPL

• Extra-4: Patient history management implemented.
• Extra-5: Chatbot implemented.

---

Contributing

For the techniacal pilot users or any other interested contributor:

🐛 Report Issues: Submit bugs found or log feature requests for the FISIOFIND project.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/Proyecto-ISPP/FISIOFIND

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b feature/new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Feat: Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

License

This project is protected under the MIT License License. For more details, refer to the LICENSE file.

Acknowledgments

We would like to express our gratitude to the three great teams that have made this project possible:

Alberto Carmona

Daniel Alors

Daniel Fernández

Daniel Ruiz

Pablo Fernández

Rafael Pulido

Antonio Macías

Benjamín Maureira

Delfín Santana

Guadalupe Ridruejo

Julen Redondo

Ramón Gavira

Daniel Tortorici

Daniel Vela

Miguel Encina

Francisco Capote

Francisco Mateos

---