Files changed (1) hide show
  1. README.md +57 -40
README.md CHANGED
@@ -1,37 +1,43 @@
1
- # 🧠 Graph Generator
2
 
3
- Espacio en Hugging Face para generar gráficos con ayuda de modelos LLM y una base de datos en Supabase.
4
 
5
- ## Clonar el repositorio
6
 
7
- ```
 
 
8
  git clone https://huggingface.co/spaces/juancamval/graph_generator
9
  cd graph_generator
10
- ````
11
 
12
- ## Crear y activar entorno virtual
13
 
14
- #### En Windows:
15
 
16
- ```
 
 
17
  python -m venv .venv
18
- .\.venv\Scripts\activate
19
  ```
20
 
21
- #### En Linux/Mac:
22
 
23
- ```
24
  python3 -m venv .venv
25
  source .venv/bin/activate
26
  ```
27
 
28
- ## Instalar dependencias
29
 
30
- ```
 
 
31
  pip install -r requirements.txt
32
  ```
33
 
34
- #### requirements.txt
35
 
36
  ```txt
37
  pandas
@@ -42,73 +48,84 @@ matplotlib
42
  pandasai
43
  ```
44
 
45
- ## Variables de entorno `.env`
 
 
46
 
47
- Crea un archivo `.env` en la raíz del proyecto con esta estructura:
48
 
49
  ```env
50
  SUPABASE_URL=
51
  SUPABASE_KEY=
52
  ```
53
 
54
- > Puedes encontrar estas variables en **Supabase > Project Settings > API Settings**:
55
- >
56
- > * **URL** → `SUPABASE_URL`
57
- > * **anon public** → `SUPABASE_KEY`
58
-
59
- ### Estructura esperada de la base de datos
60
 
61
- Asegúrate de que la estructura de la base de datos en Supabase coincida con la siguiente imagen:
 
62
 
63
- ![estructura\_db](./assets/supabase_db.png)
64
 
65
  ---
66
 
67
- ## Modelo LLM con Ollama
68
 
69
- #### 1. Instalar [Ollama](https://ollama.com/)
70
 
71
- Descarga e instala Ollama desde su sitio oficial.
72
 
73
- #### 2. Abrir Ollama
 
 
74
 
75
- Inicia Ollama para que esté activo en segundo plano.
76
 
77
- #### 3. Descargar el modelo `gemma3:12b`
78
 
79
- ```
 
 
 
 
80
  ollama pull gemma3:12b
81
  ```
82
 
 
 
83
  ---
84
 
85
- ## Ejecutar la app
86
 
87
- Con el entorno virtual activado, y Ollama corriendo:
88
 
89
- ```
90
  streamlit run app.py
91
  ```
92
 
93
  ---
94
 
95
- ## Comandos resumen
96
 
97
- ```
 
98
  git clone https://huggingface.co/spaces/juancamval/graph_generator
99
  cd graph_generator
100
 
101
  # Crear entorno virtual
102
  python -m venv .venv
103
- # Windows
104
- .\.venv\Scripts\activate
105
- # Linux/Mac
106
  source .venv/bin/activate
107
 
108
  # Instalar dependencias
109
  pip install -r requirements.txt
110
 
111
- # Descargar modelo con Ollama
 
 
 
 
112
  ollama pull gemma3:12b
113
 
114
  # Ejecutar la app
 
1
+ # 📊 Graph Generator
2
 
3
+ ---
4
 
5
+ ## 🚀 Instrucciones de instalación
6
 
7
+ ### 1. Clona el repositorio
8
+
9
+ ```bash
10
  git clone https://huggingface.co/spaces/juancamval/graph_generator
11
  cd graph_generator
12
+ ```
13
 
14
+ ---
15
 
16
+ ### 2. Crea y activa el entorno virtual
17
 
18
+ #### 🪟 En Windows
19
+
20
+ ```bash
21
  python -m venv .venv
22
+ .\.venv\Scriptsctivate
23
  ```
24
 
25
+ #### 🐧 En Linux/Mac
26
 
27
+ ```bash
28
  python3 -m venv .venv
29
  source .venv/bin/activate
30
  ```
31
 
32
+ ---
33
 
34
+ ### 3. Instala las dependencias
35
+
36
+ ```bash
37
  pip install -r requirements.txt
38
  ```
39
 
40
+ Contenido del archivo `requirements.txt`:
41
 
42
  ```txt
43
  pandas
 
48
  pandasai
49
  ```
50
 
51
+ ---
52
+
53
+ ### 4. Configura las variables de entorno
54
 
55
+ Crea un archivo `.env` en la raíz del proyecto con el siguiente contenido:
56
 
57
  ```env
58
  SUPABASE_URL=
59
  SUPABASE_KEY=
60
  ```
61
 
62
+ Puedes obtener estas credenciales desde tu panel de Supabase:
 
 
 
 
 
63
 
64
+ - `SUPABASE_URL`: Settings API URL
65
+ - `SUPABASE_KEY`: Settings → API → anon public
66
 
67
+ > ⚠️ **No compartas este archivo públicamente. Contiene información sensible.**
68
 
69
  ---
70
 
71
+ ### 5. Asegura la estructura de la base de datos
72
 
73
+ Tu base de datos en Supabase debe tener esta estructura:
74
 
75
+ > 📷 Coloca una imagen llamada `estructura_db.png` dentro de la carpeta `assets/`.
76
 
77
+ ```markdown
78
+ ![estructura de la base de datos](./assets/estructura_db.png)
79
+ ```
80
 
81
+ ---
82
 
83
+ ## 🧠 Configura el modelo local con Ollama
84
 
85
+ 1. Instala Ollama desde [https://ollama.com](https://ollama.com).
86
+ 2. Abre la aplicación Ollama.
87
+ 3. Descarga el modelo que usarás:
88
+
89
+ ```bash
90
  ollama pull gemma3:12b
91
  ```
92
 
93
+ 4. Asegúrate de que Ollama esté activo **antes de correr la app**.
94
+
95
  ---
96
 
97
+ ## ▶️ Ejecuta la aplicación
98
 
99
+ Una vez esté todo listo:
100
 
101
+ ```bash
102
  streamlit run app.py
103
  ```
104
 
105
  ---
106
 
107
+ ## 🧾 Resumen de comandos
108
 
109
+ ```bash
110
+ # Clonar el repositorio
111
  git clone https://huggingface.co/spaces/juancamval/graph_generator
112
  cd graph_generator
113
 
114
  # Crear entorno virtual
115
  python -m venv .venv
116
+ # Activar en Windows
117
+ .\.venv\Scriptsctivate
118
+ # Activar en Linux/Mac
119
  source .venv/bin/activate
120
 
121
  # Instalar dependencias
122
  pip install -r requirements.txt
123
 
124
+ # Configurar entorno (.env)
125
+ # SUPABASE_URL=
126
+ # SUPABASE_KEY=
127
+
128
+ # Descargar modelo LLM
129
  ollama pull gemma3:12b
130
 
131
  # Ejecutar la app