agilgdam / teleasistencia-servidor-django

PFC Antonio Gil: Optimización API REST Teleasistencia

teleasistencia

Dado el crecimiento del proyecto y la cantidad de aplicaciones que engloba se ha redicido dividirlo en distintos proyectos GitHub correspondientes con cada aplicación:

1. https://github.com/IES-Valle-Jerte/teleasistencia-servidor-django
2. https://github.com/IES-Valle-Jerte/teleasistencia-cliente-angular
3. https://github.com/IES-Valle-Jerte/teleasistencia-cliente-android
4. https://github.com/IES-Valle-Jerte/teleasistencia-cliente-arduino-raspberrypi

Este proyecto consiste en un desarrollo Web de un servicio de Teleasistencia para que los alumnos del FP de Atención Sociosanitaria puedan realizar prácticas en el aula como si de un entorno real se tratase.

Para probar el proyecto, y antes de realizar la instalación, se recomienda que se sigan los pasos que aparecen en Pasos para contribuir al proyecto.

Dependencias:

Se gestionan en la instalación, a través del fichero requerimentos.txt. Las dejamos aquí apuntadas por si fuese necesario revisarlas:

1. pip install Django==3.2.3
2. pip install django-model-utils==4.1.1
3. pip install djangorestframework==3.12.4
4. pip install django-rest-framework-social-oauth2==1.1.0
5. pip install django-extensions==3.1.3
6. pip install Werkzeug==2.0.2
7. pip install pyOpenSSL==21.0.0
8. pip install djangorestframework-simplejwt==5.0.0

Pasos para contribuir en el proyecto

Las contribuciones al proyecto se realizarán a través de forks y pull requests sobre el proyecto original. Se puede encontrar más información sobre este flujo de trabajo en la documentación de Github.

1. Realizar un fork del proyecto pulsando sobre el icono de fork. Cuando se realiza un fork, se crea una copia del repositorio remoto en Github, de tal manera que el usuario que hace fork tiene una copia para poder realizar modificaciones sin que afecte al desarrollo del repositorio principal o de otros forks.

   

2. Clonar el proyecto en local para su instalación y modificación.

   

Existen varias maneras de clonar un proyecto. Para simplificar todas las tareas con Git-Github se recomienda instalar Github Desktop y trabajar desde su propia interfaz gráfica.

3. Realiza la instalación del proyecto siguiendo los Pasos para la instalación.

4. Realiza las modificaciones/mejoras que consideres oportunas. Revisa los Issues del proyecto original para encontrar necesidades donde puedes contribuir.

5. Una vez has desarrollado tus contribuciones y las has probado, puedes solicitar que los cambios se añadan al repositorio principal mediante un Pull Request:

   

Pasos para la instalación:

1. Instalación de python - https://www.python.org/ . Seleccionar la opción que nos permite añadir python al PATH. Comprobamos la instalación desde cmd: python --version

2. Descargamos e instalamos el Entorno de desarrollo PyCharm - https://www.jetbrains.com/pycharm/

3. Creamos el entorno virutal en la ruta Server virtualenv venviorment

   

4. Ejecutamos el siguiente archivo para seleccionar el entorno virtual Server/venviorment/Scripts/activate. Si tuviésemos problemas de permisos para ejecutar dicho comando, revisar este enlace y correr el comando que aparece como superadministrador en PowerShell.

5. Hacemos permanente el entorno virtual. Vamos a File -> Settings... -> Project --> Python Interpreter y seleccionamos el Interprete ya creado Server\venviorment\Scripts\python.exe

   

6. Actualizamos pip pip install --upgrade pip

7. Instalamos los requerimientos pip install -r requerimientos.txt. Es posible que haya errores durante la instalación de los requisitos, si ocurriesen errores del tipo , sería necesario instalar algunos componentes para ejecutar C++ como aparece en la respuesta de esta pregunta de Stackoverflow (Descargar vs_buildtools y ejecutar el comando que aparece al final de la respuesta marcada como solución).

Arrancar el proyecto

Desde Server\teleasistencia ejecutamos python manage.py runserver_plus --cert-file cert.pem --key-file key.pem

Comprobar las peticiones

Las peticiones de la API-Rest están documentadas en Postman.

Licencia

El software ha sido desarrollado bajo la licencia GPL3 por el departamento de Informática del IES Valle del Jerte de Plasencia, con la colaboración principal de Fréderic Sánchez, Angel Enrique Pineda y Jesús Redondo.

Los alumnos que han contribuido en el desarrollo de este proyecto y la labor que han realizado son:

• Lucía González: Creación de la primera versión del cliente Angular.
• Javier Fernández: Inicialización completa de la API-Rest y Postman.

Especial mención al departamento de Atención Sociosanitaria del IES San Martín de Talayuela. Partícipes e impulsores de la plataforma de prácticas de Teleasistencia.

Sobre el Gitignore