Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/brandonvergara1220-del/Mini-Proyecto-Backend-NodeJS/llms.txt

Use this file to discover all available pages before exploring further.

The Mini Proyecto Backend NodeJS relies on a straightforward Node.js environment with a single runtime dependency. Before starting the server, you need to install dependencies, understand the available npm scripts, and — for any environment beyond a personal development machine — move sensitive credentials out of source code and into environment variables.

​
Node.js Version Requirements

Node.js v14 or later is recommended for this project. Version 14 introduced long-term support (LTS) stability and ships with an npm version that fully supports the "exports" field used internally by mysql2. You can verify your installed version with: 
node --version
npm --version
If you need to manage multiple Node.js versions on the same machine, nvm (Linux/macOS) or nvm-windows are commonly used tools.

​
npm Scripts

The package.json defines the following scripts:
package.json
"scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "start": "node server.js"
}
CommandWhat it does
npm startLaunches the application by running node server.js
npm testPlaceholder — exits with an error until a test suite is configured
To start the server in development, run: 
npm start

​
CommonJS Module System

The project is configured as a CommonJS module system:
package.json
"type": "commonjs"
This means all .js files in the project use require() and module.exports rather than ES module import/export syntax. You can see this in conexion.js, which exports the database connection with:
conexion.js
module.exports = conexion;
Any file that needs the database connection imports it with: 
const conexion = require('./conexion');

​
Dependencies

The project has one production dependency declared in package.json:
package.json
"dependencies": {
  "mysql2": "^3.22.5"
}
PackageVersionPurpose
mysql2^3.22.5MySQL client for Node.js — provides createConnection, promise-based APIs, and prepared statement support
mysql2 is a modern, actively maintained replacement for the older mysql package. It is fully API-compatible with mysql but adds support for MySQL 8 authentication, Promises, and significantly better performance.

​
Installing Dependencies

After cloning the repository, install all dependencies with: 
npm install
This reads package.json and downloads mysql2 (and its transitive dependencies) into the node_modules/ directory.
This section describes a recommended improvement for shared or production environments. The current project does not include a .env file or the dotenv package — conexion.js hard-codes credentials for local development. The steps below are not part of the existing setup; apply them if you deploy beyond a personal development machine.
The dotenv package loads credentials from a .env file so they are never embedded in source code. Install it as a development dependency: 
npm install dotenv --save-dev
Create a .env file in the project root:
.env
DB_HOST=localhost
DB_DATABASE=ejemploformulario
DB_USER=root
DB_PASSWORD=yourpassword
Then update conexion.js to read from environment variables, falling back to the original development defaults:
conexion.js
require('dotenv').config();
let mysql = require('mysql2');

let conexion = mysql.createConnection({
  host: process.env.DB_HOST || 'localhost',
  database: process.env.DB_DATABASE || 'ejemploformulario',
  user: process.env.DB_USER || 'root',
  password: process.env.DB_PASSWORD || ''
});

conexion.connect(function(error) {
  if (error) {
    throw error;
  } else {
    console.log("Conexión exitosa a la base de datos");
  }
});

module.exports = conexion;
Never commit your .env file to Git. Add it to .gitignore immediately after creating it:
echo ".env" >> .gitignore
Committing credentials — even to a private repository — is a common source of credential leaks and security incidents.

Build docs developers (and LLMs) love

Get started for freeTalk to us