netepScript 🚀

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.

Contenido 📚

• Requisitos Previos 🖥️
• Instalación ⚙️
• Scripts 📜
• Estructura del Proyecto 🏗️
• Configuración 🔧
• Contribuciones 💡
• Contacto 📬

Requisitos previos 🖥️

• Un ordenador con Windows 🪟 o Linux 🐧 o una Mac con MacOS 🍎
• Git Bash o Windows Subsystem for Linux (WSL) (solo para Windows)
• Un editor de código, preferentemente utilizar Visual Studio Code
• Permisos de administrador (opcional, para ejecutar el script con sudo para Linux)

Instalación ⚙️

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.

En Windows 🪟

• Lo ideal es utilizar una terminal de bash, como la que se encuentra disponible dentro de Visual Studio Code.

• Accede a una nueva terminal de bash, y asegúrate de estar en la carpeta donde has descomprimido netepScript.

• Luego vamos a convertir el script en ejecutable escribiendo en la consola:

chmod +x netepScript.v0-8-9.sh

• Luego estamos en condiciones de ejecutar el script para que se inicie el proceso de instalación:

./netepScript.v0-8-9.sh

En Linux 🐧 o MacOS 🍎

• Puedes acceder desde Visual Studio Code o directamente desde la terminal de Linux en la carpeta donde has descomprimido netepScript.

• Luego vamos a convertir el script en ejecutable escribiendo en la consola:

chmod +x netepScript.v0-8-9.sh

• Luego estamos en condiciones de ejecutar el script para que se inicie el proceso de instalación:

./netepScript.v0-8-9.sh

Scripts 📜

En este proyecto se han configurado varios scripts en el archivo package.json para facilitar el desarrollo y la producción:

• npm run dev # Inicia el servidor en modo de desarrollo utilizando ts-node-dev.
• npm run build # Compila el código TypeScript en JavaScript.
• npm start # Inicia el servidor utilizando el código compilado.
• npm run lint # Ejecuta ESLint para verificar la calidad del código.
• npm run format# Ejecuta Prettier para formatear el código.

Estructura del Proyecto 🏗️

• La estructura del proyecto es la siguiente:

.
├── src
│ ├── config
│ ├── controllers
│ ├── interfaces
│ ├── middlewares
│ ├── models
│ ├── routes
│ ├── servicese
│ ├── index.ts
│ └── server.ts
├── .eslintrc.json
├── .prettierrc
├── .nodemon.json
├── package.json
├── package-lock.json
├── tsconfig.json
├── .gitignore
└── README.md

• src: Carpeta principal del código fuente.
• config:
• controllers: Controladores para manejar las solicitudes HTTP.
• interfaces: Interfaces TypeScript.
• middlewares: Middlewares personalizados.
• models: Modelos de datos.
• routes: Definiciones de rutas.
• services: Servicios de la aplicación.
• index.ts: Archivo de entrada principal.
• server.ts: Archivo de configuración del servidor
• .eslintrc.json: Configuración de Elisnt.
• .prettierrc: Configuración de Prettier.
• .nodemon.json: Configuración de Nodemon.
• package.json: Archivo de configuración de npm.
• package-lock.json: Archivo de bloqueo de versiones de npm.
• tsconfig.json: Configuración de TypeScript.
• .gitignore: Archivo de configuración de gitignore.

Configuración 🔧

A continuación se describen las configuraciones más importantes del proyecto.

• TypeScript

El archivo tsconfig.json contiene la configuración de TypeScript. Aquí tienes un ejemplo de configuración básica:

{
  "compilerOptions": {
    "target": "es2016",
    "module": "commonjs",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules"]
}

• ESLint

El archivo .eslintrc.json contiene la configuración de ESLint. Aquí tienes un ejemplo de configuración básica:

module.exports = {
  parser: "@typescript-eslint/parser",
  plugins: ["@typescript-eslint", "prettier"],
  extends: [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended",
    "plugin:prettier/recommended",
  ],
  parserOptions: {
    ecmaVersion: "latest",
  },
  env: {
    es6: true,
  },
  rules: {
    "prettier/prettier": "error",
  },
};

• Prettier

El archivo .prettierrc contiene la configuración de Prettier. Aquí tienes un ejemplo de configuración básica:

{
  "singleQuote": true,
  "trailingComma": "all",
  "semi": true,
  "tabWidth": 2,
  "bracketSpacing": true,
  "arrowParens": "always",
  "endOfLine": "lf"
}

• Nodemon

  El archivo nodemon.json contiene la configuracion de Nodemon. Aquí tienes un ejemplo de configuración básica:

{
  "watch": ["src"],
  "ext": "ts,json",
  "ignore": ["src/tests/*", "node_modules"],
  "exec": "ts-node src/index.ts"
}

Contribuciones 💡

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.

Sobre Nosotros 🌍

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.

• Nuestra Misión

  • 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.

• Experiencia y Colaboración

  • 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.

• Nuestro Compromiso

  • 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.

Contacto 📬

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!

• Synergy2Devs

  • Escríbenos un email 📧
  • Nuestro GitHub

• Marcelo Robin

  • GitHub
  • Linkedin

• Jesus Garcia

  • GitHub
  • Linkedin

Ir arriba de todo ↑