Skip to content

Commit 21dd49f

Browse files
committed
Version v0-9-01 generada
1 parent e742f05 commit 21dd49f

File tree

4 files changed

+522
-266
lines changed

4 files changed

+522
-266
lines changed

README.md

Lines changed: 3 additions & 225 deletions
Original file line numberDiff line numberDiff line change
@@ -1,229 +1,7 @@
11
<a name="inicio"></a>
22
# **netepScript** 🚀
33

4-
Este script instala Node, Express, TypeScript, ESLint y Prettier automáticamente. La idea de este script es ejecutar todas las instalaciones de dependencias y configuraciones de entorno con un solo comando, agilizando el inicio de proyectos desde cero.
4+
Elige un idioma para leer la documentación:
55

6-
## **Contenido** 📚
7-
8-
- [Requisitos Previos](#requisitos-previos) 🖥️
9-
- [Instalación](#instalacion) ⚙️
10-
- [Scripts](#scripts) 📜
11-
- [Estructura del Proyecto](#estructura-del-proyecto) 🏗️
12-
- [Configuración](#configuración) 🔧
13-
- [Contribuciones](#contribuciones) 💡
14-
- [Contacto](#contacto) 📬
15-
16-
<a name="requisitos-previos"></a>
17-
## **Requisitos previos** 🖥️
18-
19-
- Un ordenador con Windows 🪟 o Linux 🐧 o una Mac con MacOS 🍎
20-
- Git Bash o Windows Subsystem for Linux (WSL) (solo para Windows)
21-
- Un editor de código, preferentemente utilizar Visual Studio Code
22-
- Permisos de administrador (opcional, para ejecutar el script con sudo para Linux)
23-
24-
<a name="instalacion"></a>
25-
## **Instalación** ⚙️
26-
27-
Para utilizar netepScript, primero crea una carpeta vacía donde alojarás tu proyecto. Descarga el archivo comprimido y descomprímelo dentro de esa carpeta. A continuación, abre la carpeta con tu editor de texto preferido o accede a ella desde la terminal de tu sistema operativo. Después de instalar todas las dependencias, se puede eliminar el archivo del script para que no se incluya en el mismo.
28-
29-
**En Windows 🪟**
30-
31-
- Lo ideal es utilizar una terminal de bash, como la que se encuentra disponible dentro de Visual Studio Code.
32-
33-
- Accede a una nueva terminal de bash, y asegúrate de estar en la carpeta donde has descomprimido netepScript.
34-
35-
- Luego vamos a convertir el script en ejecutable escribiendo en la consola:
36-
37-
```bash
38-
chmod +x netepScript.v0-8-9.sh
39-
```
40-
- Luego estamos en condiciones de ejecutar el script para que se inicie el proceso de instalación:
41-
42-
```bash
43-
./netepScript.v0-8-9.sh
44-
```
45-
**En Linux 🐧 o MacOS 🍎**
46-
47-
- Puedes acceder desde Visual Studio Code o directamente desde la terminal de Linux en la carpeta donde has descomprimido netepScript.
48-
49-
- Luego vamos a convertir el script en ejecutable escribiendo en la consola:
50-
51-
```bash
52-
chmod +x netepScript.v0-8-9.sh
53-
```
54-
- Luego estamos en condiciones de ejecutar el script para que se inicie el proceso de instalación:
55-
56-
```bash
57-
./netepScript.v0-8-9.sh
58-
```
59-
<a name="scripts"></a>
60-
**Scripts** 📜
61-
62-
En este proyecto se han configurado varios scripts en el archivo package.json para facilitar el desarrollo y la producción:
63-
64-
- _npm run dev # Inicia el servidor en modo de desarrollo utilizando ts-node-dev._
65-
- _npm run build # Compila el código TypeScript en JavaScript._
66-
- _npm start # Inicia el servidor utilizando el código compilado._
67-
- _npm run lint # Ejecuta ESLint para verificar la calidad del código._
68-
- _npm run format# Ejecuta Prettier para formatear el código._
69-
70-
<a name="estructura-del-proyecto"></a>
71-
**Estructura del Proyecto** 🏗️
72-
73-
- La estructura del proyecto es la siguiente:
74-
75-
```ts
76-
.
77-
├── src
78-
│ ├── config
79-
│ ├── controllers
80-
│ ├── interfaces
81-
│ ├── middlewares
82-
│ ├── models
83-
│ ├── routes
84-
│ ├── servicese
85-
│ ├── index.ts
86-
│ └── server.ts
87-
├── .eslintrc.json
88-
├── .prettierrc
89-
├── .nodemon.json
90-
├── package.json
91-
├── package-lock.json
92-
├── tsconfig.json
93-
├── .gitignore
94-
└── README.md
95-
```
96-
97-
- src: Carpeta principal del código fuente.
98-
- config:
99-
- controllers: Controladores para manejar las solicitudes HTTP.
100-
- interfaces: Interfaces TypeScript.
101-
- middlewares: Middlewares personalizados.
102-
- models: Modelos de datos.
103-
- routes: Definiciones de rutas.
104-
- services: Servicios de la aplicación.
105-
- index.ts: Archivo de entrada principal.
106-
- server.ts: Archivo de configuración del servidor
107-
- .eslintrc.json: Configuración de Elisnt.
108-
- .prettierrc: Configuración de Prettier.
109-
- .nodemon.json: Configuración de Nodemon.
110-
- package.json: Archivo de configuración de npm.
111-
- package-lock.json: Archivo de bloqueo de versiones de npm.
112-
- tsconfig.json: Configuración de TypeScript.
113-
- .gitignore: Archivo de configuración de gitignore.
114-
115-
<a name="configuracion"></a>
116-
## **Configuración** 🔧
117-
118-
A continuación se describen las configuraciones más importantes del proyecto.
119-
120-
- _TypeScript_
121-
122-
El archivo tsconfig.json contiene la configuración de TypeScript. Aquí tienes un ejemplo de configuración básica:
123-
124-
```json
125-
{
126-
"compilerOptions": {
127-
"target": "es2016",
128-
"module": "commonjs",
129-
"outDir": "./dist",
130-
"rootDir": "./src",
131-
"strict": true,
132-
"esModuleInterop": true
133-
},
134-
"include": ["src/**/*.ts"],
135-
"exclude": ["node_modules"]
136-
}
137-
```
138-
139-
- _ESLint_
140-
141-
El archivo .eslintrc.json contiene la configuración de ESLint. Aquí tienes un ejemplo de configuración básica:
142-
143-
```ts
144-
module.exports = {
145-
parser: "@typescript-eslint/parser",
146-
plugins: ["@typescript-eslint", "prettier"],
147-
extends: [
148-
"eslint:recommended",
149-
"plugin:@typescript-eslint/recommended",
150-
"plugin:prettier/recommended",
151-
],
152-
parserOptions: {
153-
ecmaVersion: "latest",
154-
},
155-
env: {
156-
es6: true,
157-
},
158-
rules: {
159-
"prettier/prettier": "error",
160-
},
161-
};
162-
```
163-
164-
- _Prettier_
165-
166-
El archivo .prettierrc contiene la configuración de Prettier. Aquí tienes un ejemplo de configuración básica:
167-
168-
```json
169-
{
170-
"singleQuote": true,
171-
"trailingComma": "all",
172-
"semi": true,
173-
"tabWidth": 2,
174-
"bracketSpacing": true,
175-
"arrowParens": "always",
176-
"endOfLine": "lf"
177-
}
178-
```
179-
180-
- _Nodemon_
181-
182-
El archivo nodemon.json contiene la configuracion de Nodemon. Aquí tienes un ejemplo de configuración básica:
183-
184-
```json
185-
{
186-
"watch": ["src"],
187-
"ext": "ts,json",
188-
"ignore": ["src/tests/*", "node_modules"],
189-
"exec": "ts-node src/index.ts"
190-
}
191-
```
192-
<a name="contribuciones"></a>
193-
## **Contribuciones** 💡
194-
195-
Las contribuciones son bienvenidas. Si tienes alguna sugerencia o mejora, abre un issue o un pull request para discutir cualquier cambio que te gustaría hacer.
196-
197-
<a name="sobre-nosotros"></a>
198-
## **Sobre Nosotros** 🌍
199-
200-
Somos un equipo de desarrolladores apasionados por la creación de soluciones innovadoras y robustas en el ámbito de la programación. Nos especializamos en el desarrollo de aplicaciones escalables y eficientes utilizando tecnologías modernas y buenas prácticas de ingeniería de software.
201-
202-
- **Nuestra Misión**
203-
* Impulsar el desarrollo de software de calidad, abordando desafíos técnicos con creatividad y compromiso. Buscamos no solo resolver problemas, sino también inspirar y colaborar con otros desarrolladores para construir un futuro digital más avanzado y accesible.
204-
205-
- **Experiencia y Colaboración**
206-
* Con una trayectoria combinada en proyectos diversos, desde aplicaciones web hasta soluciones empresariales, hemos adquirido experiencia en el diseño de arquitecturas sólidas y en la implementación de soluciones eficaces que cumplen con las necesidades del cliente.
207-
208-
- **Nuestro Compromiso**
209-
* Estamos comprometidos con la excelencia técnica y la mejora continua. Creemos en compartir nuestro conocimiento a través de código abierto y contribuciones a la comunidad, fortaleciendo así el ecosistema de desarrollo de software global.
210-
211-
<a name="contacto"></a>
212-
## **Contacto** 📬
213-
214-
Estamos listos para escuchar tus ideas y explorar cómo podemos trabajar juntos para llevarlas al siguiente nivel. ¡Contáctanos hoy y comencemos a construir el futuro!
215-
216-
217-
- **Synergy2Devs**
218-
- <a href="mailto:[email protected]">Escríbenos un email 📧</a>
219-
- [Nuestro GitHub](https://github.com/Synergy2Devs)
220-
221-
- **Marcelo Robin**
222-
- [GitHub](https://github.com/mnibor)
223-
- [Linkedin](https://www.linkedin.com/in/marcelo-a-robin-3605b1286/)
224-
225-
- **Jesus Garcia**
226-
- [GitHub](https://github.com/JAJesusGarcia)
227-
- [Linkedin](https://www.linkedin.com/in/jesusjagarcia/)
228-
229-
[Ir arriba de todo ↑](#inicio)
6+
- [Documentación en Español](docs/README.es.md)
7+
- [Documentation in English](docs/README.en.md)

0 commit comments

Comments
 (0)