mtahan commited on
Commit
21f297c
·
verified ·
1 Parent(s): 3d22685

Update README.md

Browse files

[UPD] Updating readme file project

Files changed (1) hide show
  1. README.md +101 -0
README.md CHANGED
@@ -10,3 +10,104 @@ short_description: Ejemplo académico para hacer un CRUD con Flask de Pytho
10
  ---
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  ---
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
13
+
14
+ # ☁️ Proyecto CRUD: Registro de Personas (Cloud - Hugging Face & Docker)
15
+
16
+ Esta versión del sistema de Registro de Personas está optimizada para el despliegue en la nube a través de **Hugging Face Spaces** utilizando contenedores **Docker**.
17
+
18
+ ---
19
+
20
+ # ☁️ CRUD Project: Registration of Persons (Cloud - Hugging Face & Docker)
21
+
22
+ This version of the Registration of Persons system is optimized for cloud deployment via **Hugging Face Spaces** using **Docker** containers.
23
+
24
+ ---
25
+
26
+ ## 🛠️ Características Especiales (Special Features)
27
+ - **Despliegue**: Dockerizado para máxima compatibilidad.
28
+ - **Producción**: Utiliza `Gunicorn` como servidor profesional.
29
+ - **Seguridad de Sesión**: Configuración fija de `secret_key` y cookies `SameSite=None` para permitir el funcionamiento dentro de iFrames (requerido por Hugging Face).
30
+ - **Estabilidad**: Configurado con un solo trabajador (`workers 1`) para garantizar la persistencia de la sesión.
31
+
32
+ ---
33
+
34
+ ## Special Features
35
+
36
+ - **Deployment**: Dockerized for maximum compatibility.
37
+ - **Production**: Uses `Gunicorn` as a professional server.
38
+ - **Session Security**: Fixed `secret_key` configuration and `SameSite=None` cookies to allow operation within iFrames (required by Hugging Face).
39
+ - **Stability**: Configured with a single worker (`workers 1`) to ensure session persistence.
40
+
41
+ ---
42
+
43
+ ## 🚀 Despliegue
44
+
45
+ ### Opción A: Mediante el formulario de Upload Files de Hugging Face
46
+ Sube la carpeta con el proyecto directamente a tu Space en Hugging Face.
47
+
48
+ ### Opción B: Mediante Git
49
+ 1. Crea un nuevo Space de tipo **Docker**.
50
+ 2. Haz el commit del contenido de esta carpeta:
51
+ ```bash
52
+ git add .
53
+ git commit -m "Despliegue inicial en Hugging Face"
54
+ git push origin main
55
+ ```
56
+
57
+ ---
58
+
59
+ ## 🚀 Deployment
60
+
61
+ ### Option A: Using the Hugging Face Upload Files form
62
+ Upload the folder with the project directly to your Space on Hugging Face.
63
+
64
+ ### Option B: Using Git
65
+ 1. Create a new **Docker** type Space.
66
+ 2. Commit the contents of this folder:
67
+ ```bash
68
+ git add .
69
+ git commit -m "Initial deployment on Hugging Face"
70
+ git push origin main
71
+ ```
72
+
73
+ ---
74
+
75
+ ## 🔧 Archivos Clave (Key Files)
76
+ - `Dockerfile`: Instrucciones para construir el contenedor.
77
+ - `app.py`: Configuración optimizada para la nube.
78
+ - `requirements.txt`: Dependencias requeridas.
79
+
80
+ ---
81
+
82
+ ## 🔧 Key Files
83
+ - `Dockerfile`: Instructions for building the container.
84
+ - `app.py`: Configuration optimized for the cloud.
85
+ - `requirements.txt`: Required dependencies.
86
+
87
+ ---
88
+
89
+ ## 🎓 Créditos
90
+
91
+ - **Product Owner**: Prof. Mónica Tahan
92
+ - **Desarrollo**: Mónica Tahan & Google Antigravity AI
93
+ - **Institución**: UNEXPO - Nucleo Guarenas
94
+ - **Asignatura**: Computación 1
95
+ - **Sección**: 37
96
+
97
+ ---
98
+ > [!NOTA]
99
+ > Este proyecto tiene fines puramente didácticos para la enseñanza de estructuras de datos y desarrollo web en ingeniería.
100
+
101
+ ---
102
+
103
+ ## 🎓 Credits
104
+
105
+ - **Product Owner**: Prof. Mónica Tahan
106
+ - **Development**: Mónica Tahan & Google Antigravity AI
107
+ - **Institution**: UNEXPO - Nucleo Guarenas
108
+ - **Course**: Computación 1
109
+ - **Section**: 37
110
+
111
+ ---
112
+ > [!NOTE]
113
+ > This project is for purely didactic purposes for teaching data structures and web development in engineering.