Skip to content

Commit 6ee163a

Browse files
Merge pull request #10 from andresWeitzel/documentation-01-add-readme-en-sp
documentation-add-readme-en-sp
2 parents 26dec38 + 950c042 commit 6ee163a

File tree

19 files changed

+632
-271
lines changed

19 files changed

+632
-271
lines changed

README.md

Lines changed: 86 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,237 +1,250 @@
11
![Index app](./doc/assets/gRPC.png)
22

3+
<div align="right">
4+
<a href="./translation/README.es.md" target="_blank">
5+
<img src="./doc/assets/translation/arg-flag.jpg" width="10%" height="10%" />
6+
</a>
7+
<a href="./README.md" target="_blank">
8+
<img src="./doc/assets/translation/eeuu-flag.jpg" width="10%" height="10%" />
9+
</a>
10+
</div>
11+
12+
<div align="center">
13+
314
# gRPC\_IP\_Geolocation\_API\_Integration\_Nodejs
415

5-
Api gRPC protobuf para la integración de servicios de IPWHOIS.IO implementado con Nodejs, Expressjs, etc
16+
</div>
617

7-
* [Playlist Prueba de Funcionalidad](https://www.youtube.com/playlist?list=PLCl11UFjHurD2RjD9OiBfyKpsgwEzZzBv)
18+
gRPC protobuf api for the integration of IPWHOIS.IO services implemented with Nodejs, Expressjs, Jest, Testing, others.
19+
20+
* [Playlist Prueba de Funcionalidad](https://www.youtube.com/playlist?list=PLCl11UFjHurD2RjD9OiBfyKpsgwEzZzBv)<a href="https://www.youtube.com/playlist?list=PLCl11UFjHurD2RjD9OiBfyKpsgwEzZzBv" target="_blank"> <img src="./doc/assets/social-networks/yt.png" width="5%" height="5%" /> </a>
821
* [IPWHOIS.io api doc](https://ipwhois.io/documentation)
922

1023
<br>
1124

12-
## Índice 📜
25+
## Index 📜
1326

1427
<details>
15-
<summary> Ver </summary>
28+
<summary> See </summary>
1629

1730
<br>
1831

19-
### Sección 1) Descripción, configuración y tecnologías
32+
### Section 1) Description, configuration and technologies
2033

21-
* [1.0) Descripción del Proyecto.](#10-descripción-)
22-
* [1.1) Ejecución del Proyecto.](#11-ejecución-del-proyecto-)
23-
* [1.2) Configuración del proyecto desde cero](#12-configuración-del-proyecto-desde-cero-)
24-
* [1.3) Tecnologías.](#13-tecnologías-)
34+
* [1.0) Project Description.](#10-description-)
35+
* [1.1) Project Execution.](#11-project-execution-)
36+
* [1.2) Project setup from scratch](#12-project-setup-from-scratch-)
37+
* [1.3) Technologies.](#13-technologies-)
2538

26-
### Sección 2) Endpoints y Ejemplos
39+
### Section 2) Endpoints and Examples
2740

28-
* [2.0) EndPoints y recursos.](#20-endpoints-y-recursos-)
41+
* [2.0) EndPoints and resources.](#20-endpoints-and-resources-)
2942

30-
### Sección 3) Prueba de funcionalidad y Referencias
43+
### Section 3) Functionality Testing and References
3144

32-
* [3.0) Prueba de funcionalidad.](#30-prueba-de-funcionalidad-)
33-
* [3.1) Referencias.](#31-referencias-)
45+
* [3.0) Functionality test.](#30-functionality-test-)
46+
* [3.1) References.](#31-references-)
3447

3548
<br>
3649

3750
</details>
3851

3952
<br>
4053

41-
## Sección 1) Descripción, configuración y tecnologías
54+
## Section 1) Description, configuration and technologies
4255

43-
### 1.0) Descripción [🔝](#índice-)
56+
### 1.0) Description [🔝](#index-)
4457

4558
<details>
46-
<summary>Ver</summary>
59+
<summary>See</summary>
4760
<br>
4861

49-
### 1.0.0) Descripción General
62+
### 1.0.0) General Description
5063

5164
*
5265

53-
### 1.0.1) Descripción Arquitectura y Funcionamiento
66+
### 1.0.1) Description Architecture and Operation
5467

5568
*
5669

5770
<br>
5871

5972
</details>
6073

61-
### 1.1) Ejecución del Proyecto [🔝](#índice-)
74+
### 1.1) Project Execution [🔝](#index-)
6275

6376
<details>
64-
<summary>Ver</summary>
65-
<br>
77+
<summary>See</summary>
78+
<br>
6679

67-
#### 1.1.0) Configuraciones iniciales
80+
#### 1.1.0) Initial settings
6881

69-
* Una vez creado un entorno de trabajo a través de algún ide, clonamos el proyecto
82+
* Once a work environment has been created through some IDE, we clone the project
7083

7184
```git
7285
git clone https://github.com/andresWeitzel/gRPC_Netflix_CRUD_Nodejs
7386
```
7487

75-
* Nos posicionamos sobre el proyecto
88+
* We position ourselves on the project
7689

7790
```git
7891
cd 'projectName'
7992
```
8093

81-
* Instalamos la última versión LTS de [Nodejs(v18)](https://nodejs.org/en/download).
82-
* Instalamos todas las librerías necesarias
94+
* We install the latest LTS version of [Nodejs(v18)](https://nodejs.org/en/download).
95+
* We install all the necessary libraries
8396

8497
```git
8598
npm i
8699
```
87100

88-
* Las variables de entorno utilizadas en el proyecto se mantienen para simplificar el proceso de configuración de las mismas. Es recomendado agregar el archivo correspondiente (.env) al .gitignore.
89-
* El siguiente script configurado en el package.json del proyecto es el encargado de
90-
* Levantar el servidor con express (entorno productivo)
91-
* Levantar el servidor con express y nodemon (entorno local dev)
101+
* The environment variables used in the project are maintained to simplify their configuration process. It is recommended to add the corresponding file (.env) to the .gitignore.
102+
* The following script configured in the project's package.json is responsible for
103+
* Raise the server with express (productive environment)
104+
* Raise the server with express and nodemon (local dev environment)
92105

93106
```git
94107
"scripts": {
95-
"dev": "nodemon src/server.js",
96-
"start": "node src/server.js"
97-
},
108+
"dev": "nodemon src/server.js",
109+
"start": "node src/server.js"
110+
},
98111
```
99112

100-
* Ejecutamos la app desde terminal para entorno local.
113+
* We run the app from a terminal for a local environment.
101114

102115
```git
103116
npm run dev
104117
```
105118

106-
* Ejecutamos la app desde terminal para entorno productivo.
119+
* We run the app from a terminal for a productive environment.
107120

108121
```git
109122
npm start
110123
```
111124

112-
* Si se presenta algún mensaje indicando qué el puerto 8080 ya está en uso, podemos terminar todos los procesos dependientes y volver a ejecutar la app
125+
* If a message appears indicating that port 8080 is already in use, we can terminate all dependent processes and run the app again
113126

114127
```git
115128
npx kill-port 8080
116-
npm run dev o npm start
129+
npm run dev or npm start
117130
```
118131

119132
<br>
120133

121134
</details>
122135

123-
### 1.2) Configuración del proyecto desde cero [🔝](#índice-)
136+
### 1.2) Project configuration from scratch [🔝](#index-)
124137

125138
<details>
126-
<summary>Ver</summary>
127-
<br>
139+
<summary>See</summary>
140+
<br>
128141

129-
#### 1.2.0) Configuraciones iniciales
142+
#### 1.2.0) Initial settings
130143

131-
* Una vez creado un entorno de trabajo a través de algún ide, clonamos el proyecto
144+
* Once a work environment has been created through some IDE, we clone the project
132145

133146
```git
134147
git clone https://github.com/andresWeitzel/gRPC_Netflix_CRUD_Nodejs
135148
```
136149

137-
* Nos posicionamos sobre el proyecto
150+
* We position ourselves on the project
138151

139152
```git
140153
cd 'projectName'
141154
```
142155

143-
* Instalamos la última versión LTS de [Nodejs(v18)](https://nodejs.org/en/download)
144-
* Abrimos una terminal desde vsc
145-
* Inicializamos un proyecto nodejs
156+
* We install the latest LTS version of [Nodejs(v18)](https://nodejs.org/en/download)
157+
* We open a terminal from vsc
158+
* We initialize a nodejs project
146159

147160
```git
148161
npm init -y
149162
```
150163

151-
* Creamos un archivo .gitignore y agregamos los files necesarios (por el momento node\_modules)
164+
* We create a .gitignore file and add the necessary files (for the moment node\_modules)
152165

153166
```git
154167
node_modules
155168
```
156169

157-
* Creamos un direct source (src) para agregar toda la lógica de nuestra app
158-
* Instalamos el plugin para [express (framework)](https://www.npmjs.com/package/express)
170+
* We create a direct source (src) to add all the logic of our app
171+
* We install the plugin for [express (framework)](https://www.npmjs.com/package/express)
159172

160173
```git
161174
npm i express
162175
```
163176

164-
* Instalamos el plugin para [cors (gestión de recursos)](https://www.npmjs.com/package/cors)
177+
* We install the plugin for [cors (resource management)](https://www.npmjs.com/package/cors)
165178

166179
```git
167180
npm i cors
168181
```
169182

170-
* Instalamos el plugin para [dotenv (variables de entorno)](https://www.npmjs.com/package/dotenv)
183+
* We install the plugin for [dotenv (environment variables)](https://www.npmjs.com/package/dotenv)
171184

172185
```git
173186
npm i dotenv
174187
```
175188

176-
* Instalamos el plugin para [morgan-middleware (errores, formatos, etc)](https://expressjs.com/en/resources/middleware/morgan.html)
189+
* We install the plugin for [morgan-middleware (errors, formats, etc)](https://expressjs.com/en/resources/middleware/morgan.html)
177190

178191
```git
179192
npm i morgan
180193
```
181194

182-
Instalamos uuid para id's unicos
195+
We install uuid for unique ids
183196

184197
```git
185198
npm i uuid
186199
```
187200

188-
* Instalamos el plugin para [nodemon (autoreload server)](https://www.npmjs.com/package/nodemon) de forma global
201+
* We install the plugin for [nodemon (autoreload server)](https://www.npmjs.com/package/nodemon) globally
189202

190203
```git
191204
npm i -g nodemon
192205
```
193206

194-
* Instalamos el plugin para [nodemon (autoreload server)](https://www.npmjs.com/package/nodemon) para desarrollo
207+
* We install the plugin for [nodemon (autoreload server)](https://www.npmjs.com/package/nodemon) for development
195208

196209
```git
197210
npm i nodemon --save-dev
198211
```
199212

200-
* Instalamos las librerías para el [compilador gRPC](https://www.npmjs.com/package/@grpc/proto-loader)
213+
* We install the libraries for the [gRPC compiler](https://www.npmjs.com/package/@grpc/proto-loader)
201214

202215
```git
203216
npm i @grpc/proto-loader
204217
```
205218

206-
* Las variables de entorno utilizadas en el proyecto se mantienen para simplificar el proceso de configuración de las mismas. Es recomendado agregar el archivo correspondiente (.env) al .gitignore.
207-
* El siguiente script configurado en el package.json del proyecto es el encargado de
208-
* Levantar el servidor con express (entorno productivo)
209-
* Levantar el servidor con express y nodemon (entorno local dev)
219+
* The environment variables used in the project are maintained to simplify their configuration process. It is recommended to add the corresponding file (.env) to the .gitignore.
220+
* The following script configured in the project's package.json is responsible for
221+
* Raise the server with express (productive environment)
222+
* Raise the server with express and nodemon (local dev environment)
210223

211224
```git
212225
"scripts": {
213-
"dev": "nodemon src/server.js",
214-
"start": "node src/server.js"
215-
},
226+
"dev": "nodemon src/server.js",
227+
"start": "node src/server.js"
228+
},
216229
```
217230

218-
* Ejecutamos la app desde terminal para entorno local.
231+
* We run the app from a terminal for a local environment.
219232

220233
```git
221234
npm run dev
222235
```
223236

224-
* Ejecutamos la app desde terminal para entorno productivo.
237+
* We run the app from a terminal for a productive environment.
225238

226239
```git
227240
npm start
228241
```
229242

230-
* Si se presenta algún mensaje indicando qué el puerto 8080 ya está en uso, podemos terminar todos los procesos dependientes y volver a ejecutar la app
243+
* If a message appears indicating that port 8080 is already in use, we can terminate all dependent processes and run the app again
231244

232245
```git
233246
npx kill-port 8080
234-
npm run dev o npm start
247+
npm run dev or npm start
235248
```
236249

237250
<br>
@@ -317,8 +330,6 @@ npm run dev o npm start
317330

318331
#### Ejemplos código
319332

320-
<<<<<<< HEAD
321-
322333
* [Ejemplo base](https://www.honeybadger.io/blog/building-apis-with-node-js-and-grpc/)
323334
* [Integración Api restful con rpc](https://blog.logrocket.com/communicating-between-node-js-microservices-with-grpc/)
324335
* [Crud grpc express-nodejs](https://blog.logrocket.com/creating-a-crud-api-with-node-express-and-grpc/)
@@ -328,12 +339,9 @@ npm run dev o npm start
328339

329340
* [Documentación recomendada](https://blog.logrocket.com/creating-a-crud-api-with-node-express-and-grpc/)
330341

331-
\=======
332-
333342
* [Crud grpc express-nodejs](https://blog.logrocket.com/creating-a-crud-api-with-node-express-and-grpc/)
334-
* [Videotutorial Crud grpc express-nodejs](https://www.youtube.com/watch?v=xBO7RohEhOY)
335343

336-
> > > > > > > c1346c4585f1dc1ca3f0eb94180dce90c70962ad
344+
* [Videotutorial Crud grpc express-nodejs](https://www.youtube.com/watch?v=xBO7RohEhOY)
337345

338346
#### Librerías
339347

@@ -346,6 +354,10 @@ npm run dev o npm start
346354
* [remark-preset-lint-recommended](https://www.npmjs.com/package/remark-preset-lint-recommended)
347355
* [remark-reference-links](https://www.npmjs.com/package/remark-reference-links)
348356

357+
#### Jest
358+
359+
* [Environment vars solution](https://stackoverflow.com/questions/48033841/test-process-env-with-jest)
360+
349361
<br>
350362

351363
<br>

doc/assets/social-networks/yt.png

103 KB
Loading
1.32 MB
Loading
1.47 MB
Loading

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)