Skip to content

Commit 950c042

Browse files
committed
Updated README.md
1 parent 82c6dd6 commit 950c042

File tree

16 files changed

+282
-267
lines changed

16 files changed

+282
-267
lines changed

README.md

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

3-
# Update here
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">
413

514
# gRPC\_IP\_Geolocation\_API\_Integration\_Nodejs
615

7-
Api gRPC protobuf para la integración de servicios de IPWHOIS.IO implementado con Nodejs, Expressjs, etc
16+
</div>
17+
18+
gRPC protobuf api for the integration of IPWHOIS.IO services implemented with Nodejs, Expressjs, Jest, Testing, others.
819

9-
* [Playlist Prueba de Funcionalidad](https://www.youtube.com/playlist?list=PLCl11UFjHurD2RjD9OiBfyKpsgwEzZzBv)
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>
1021
* [IPWHOIS.io api doc](https://ipwhois.io/documentation)
1122

1223
<br>
1324

14-
## Índice 📜
25+
## Index 📜
1526

1627
<details>
17-
<summary> Ver </summary>
28+
<summary> See </summary>
1829

1930
<br>
2031

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

23-
* [1.0) Descripción del Proyecto.](#10-descripción-)
24-
* [1.1) Ejecución del Proyecto.](#11-ejecución-del-proyecto-)
25-
* [1.2) Configuración del proyecto desde cero](#12-configuración-del-proyecto-desde-cero-)
26-
* [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-)
2738

28-
### Sección 2) Endpoints y Ejemplos
39+
### Section 2) Endpoints and Examples
2940

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

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

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

3748
<br>
3849

3950
</details>
4051

4152
<br>
4253

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

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

4758
<details>
48-
<summary>Ver</summary>
59+
<summary>See</summary>
4960
<br>
5061

51-
### 1.0.0) Descripción General
62+
### 1.0.0) General Description
5263

5364
*
5465

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

5768
*
5869

5970
<br>
6071

6172
</details>
6273

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

6576
<details>
66-
<summary>Ver</summary>
67-
<br>
77+
<summary>See</summary>
78+
<br>
6879

69-
#### 1.1.0) Configuraciones iniciales
80+
#### 1.1.0) Initial settings
7081

71-
* 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
7283

7384
```git
7485
git clone https://github.com/andresWeitzel/gRPC_Netflix_CRUD_Nodejs
7586
```
7687

77-
* Nos posicionamos sobre el proyecto
88+
* We position ourselves on the project
7889

7990
```git
8091
cd 'projectName'
8192
```
8293

83-
* Instalamos la última versión LTS de [Nodejs(v18)](https://nodejs.org/en/download).
84-
* 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
8596

8697
```git
8798
npm i
8899
```
89100

90-
* 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.
91-
* El siguiente script configurado en el package.json del proyecto es el encargado de
92-
* Levantar el servidor con express (entorno productivo)
93-
* 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)
94105

95106
```git
96107
"scripts": {
97-
"dev": "nodemon src/server.js",
98-
"start": "node src/server.js"
99-
},
108+
"dev": "nodemon src/server.js",
109+
"start": "node src/server.js"
110+
},
100111
```
101112

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

104115
```git
105116
npm run dev
106117
```
107118

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

110121
```git
111122
npm start
112123
```
113124

114-
* 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
115126

116127
```git
117128
npx kill-port 8080
118-
npm run dev o npm start
129+
npm run dev or npm start
119130
```
120131

121132
<br>
122133

123134
</details>
124135

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

127138
<details>
128-
<summary>Ver</summary>
129-
<br>
139+
<summary>See</summary>
140+
<br>
130141

131-
#### 1.2.0) Configuraciones iniciales
142+
#### 1.2.0) Initial settings
132143

133-
* 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
134145

135146
```git
136147
git clone https://github.com/andresWeitzel/gRPC_Netflix_CRUD_Nodejs
137148
```
138149

139-
* Nos posicionamos sobre el proyecto
150+
* We position ourselves on the project
140151

141152
```git
142153
cd 'projectName'
143154
```
144155

145-
* Instalamos la última versión LTS de [Nodejs(v18)](https://nodejs.org/en/download)
146-
* Abrimos una terminal desde vsc
147-
* 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
148159

149160
```git
150161
npm init -y
151162
```
152163

153-
* 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)
154165

155166
```git
156167
node_modules
157168
```
158169

159-
* Creamos un direct source (src) para agregar toda la lógica de nuestra app
160-
* 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)
161172

162173
```git
163174
npm i express
164175
```
165176

166-
* 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)
167178

168179
```git
169180
npm i cors
170181
```
171182

172-
* 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)
173184

174185
```git
175186
npm i dotenv
176187
```
177188

178-
* 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)
179190

180191
```git
181192
npm i morgan
182193
```
183194

184-
Instalamos uuid para id's unicos
195+
We install uuid for unique ids
185196

186197
```git
187198
npm i uuid
188199
```
189200

190-
* 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
191202

192203
```git
193204
npm i -g nodemon
194205
```
195206

196-
* 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
197208

198209
```git
199210
npm i nodemon --save-dev
200211
```
201212

202-
* 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)
203214

204215
```git
205216
npm i @grpc/proto-loader
206217
```
207218

208-
* 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.
209-
* El siguiente script configurado en el package.json del proyecto es el encargado de
210-
* Levantar el servidor con express (entorno productivo)
211-
* 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)
212223

213224
```git
214225
"scripts": {
215-
"dev": "nodemon src/server.js",
216-
"start": "node src/server.js"
217-
},
226+
"dev": "nodemon src/server.js",
227+
"start": "node src/server.js"
228+
},
218229
```
219230

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

222233
```git
223234
npm run dev
224235
```
225236

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

228239
```git
229240
npm start
230241
```
231242

232-
* 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
233244

234245
```git
235246
npx kill-port 8080
236-
npm run dev o npm start
247+
npm run dev or npm start
237248
```
238249

239250
<br>
@@ -329,8 +340,8 @@ npm run dev o npm start
329340
* [Documentación recomendada](https://blog.logrocket.com/creating-a-crud-api-with-node-express-and-grpc/)
330341

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

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

335346
#### Librerías
336347

@@ -343,6 +354,10 @@ npm run dev o npm start
343354
* [remark-preset-lint-recommended](https://www.npmjs.com/package/remark-preset-lint-recommended)
344355
* [remark-reference-links](https://www.npmjs.com/package/remark-reference-links)
345356

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

348363
<br>

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.

package.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77
"start": "node src/server.js",
88
"start:dev": "nodemon src/server.js",
99
"start:rpc": "node src/server-rpc.js",
10+
"format-prettier": "prettier --write \"{src,test}/**/*.{js,ts}\"",
1011
"check": "remark . --quiet --frail",
11-
"format": "remark . --quiet --frail --output",
12+
"format-remark": "remark . --quiet --frail --output",
1213
"format-md": "remark . --output",
1314
"test": "jest --verbose --detectOpenHandles",
1415
"test:watch": "jest --watch --verbose --detectOpenHandles",
@@ -31,7 +32,7 @@
3132
"fs": "^0.0.1-security",
3233
"morgan": "^1.10.0",
3334
"nodemon": "^3.0.1",
34-
"prettier": "^3.0.3",
35+
"prettier": "^3.2.4",
3536
"uuid": "^9.0.1"
3637
},
3738
"devDependencies": {
@@ -64,7 +65,10 @@
6465
"remark-lint-strong-marker",
6566
"*"
6667
],
67-
["remark-lint-heading-style", "atx" ]
68+
[
69+
"remark-lint-heading-style",
70+
"atx"
71+
]
6872
]
6973
}
7074
}

0 commit comments

Comments
 (0)