Dev.to

¿Cómo ejecutar Node.js, PostgreSQL y Express.js en contenedores dentro de un entorno de desarrollo?

Si no quieres depender de algún entorno de desarrollo integrado (IDE) en la nube (GitHub Codespaces, Firebase Studio, Replit, etc) la clave es usar Docker, Docker Compose, Git, y un repositorio en la nube como GitHub, GitLab o Bitbucket. Descripción general: Este tutorial consiste en Dockerizar una aplicación Backend de Node.js y una base de datos de PostgresSQL, controlando todo el stack de la aplicación con un solo archivo. Los temas cubiertos incluye: Ejecutar PostgresSQL, Adminer en un contenedor local. Conterizar aplicación Node.js. Configurar archivo Docker Compose y Dockerfile. Definiciones. Docker Dado que Docker está disponible y es compatible con Linux, macOS y Windows, la mayoría del software puede ser utilizado en cualquier computadora. Docker simplifica y flexibiliza el proceso de configuración de la aplicación, permitiéndole implementar, administrar y escalar bases de datos en contenedores aislados con solo unos pocos comandos. Docker Compose Docker Compose simplifica el control de toda tu stack de aplicaciones, lo que facilita la gestión de servicios, redes y volúmenes en un único archivo de configuración YAML comprensible. Luego, con un solo comando, puedes crear y iniciar todos los servicios desde tu archivo de configuración. Git Es un sistema de control de versiones que permite a los desarrolladores guardar diferentes versiones de archivos y rastrear los cambios realizados en un proyecto. GitHub Es una plataforma basada en la nube que aloja repositorios de código y facilita la colaboración entre desarrolladores, permitiendo que trabajen en proyectos simultáneamente y mantengan un seguimiento de los cambios. Requisitos: Instalar Docker. Instalar Docker Compose. Instalar Node.js. Instalar Git. Una cuenta de GitHub. Si clonas el repositorio de GitHub, ve al Paso 2 - Dockeriza la aplicación.. Paso 1 - Crea el proyecto local. A continuación, se va a describir cómo crear la app con Node.js sin Docker, con una breve explicación de cada una de sus partes. 1. Crea el directorio del proyecto: Pega los siguientes comandos en tu terminal: mkdir members-only cd members-only 2. Crea los archivos y directorios de la aplicación: Pega los siguientes comandos en tu terminal: mkdir src controllers db middleware public routes views touch package.json 3. Configurar tu package.json: En el package.json pega lo siguiente: { "name": "docker-compose", "version": "1.0.0", "private": true, "main": "src/app.js", "keywords": [], "author": "", "license": "ISC", "description": "", "scripts": { "start": "nodemon src/app.js", "deploy": "node src/app.js", "formatter": "semistandard --fix" }, "dependencies": { "bcrypt": "5.1.1", "dotenv": "16.4.7", "ejs": "3.1.10", "express": "4.21.2", "express-session": "1.18.1", "express-validator": "7.2.1", "passport": "0.7.0", "passport-local": "1.0.0", "pg": "8.13.3" }, "devDependencies": { "nodemon": "3.1.9", "semistandard": "17.0.0" }, "eslintConfig": { "extends": [ "./node_modules/semistandard/eslintrc.json" ] }, "nodemonConfig": { "watch": [ "src" ], "ignore": [ "*.test.ts" ], "delay": "3", "execMap": { "ts": "ts-node" } } } IMPORTANTE: Debido a que la aplicación se ejecutará dentro de un contenedor, Te recomiendo utilizar nodemon en lugar de node --watch. Este último presenta inestabilidad en contenedores, ya que solo detecta modificaciones en los archivos una única vez y deja de monitorearlos posteriormente. Explicando package.json: "main": "src/app.js", El archivo principal es src/app.js. “scripts”: start: Corre la app con nodemon (modo desarrollo). deploy: Corre la app en producción formatter: Formatea el código con semistandard. “Dependencies”: express: Servidor web. ejs: Plantillas HTML. dotenv: Variables de entorno. bcrypt: Encriptación. passport / passport-local: Autenticación. express-session: Manejo de sesiones. express-validator: Validación de datos. pg: Conexión a PostgreSQL. “devDependencies”: nodemon: Recarga automática en desarrollo. semistandard: Reglas de estilo. nodemon observa src/, ignora .test.ts, espera 3 segundos para reiniciar. 4. Configura app.js. Crea el archivo app.js en el directorio src: touch src/app.js Pega el siguiente código en src/app.js: const path = require("node:path"); const express = require("express"); const session = require("express-session"); const passport = require("passport"); const routes = require("./routes/index.js") const app = express(); app.set("views", path.join(__dirname, "views")); app.set("view engine", "ejs"); app.use(express.static(path.join(__dirname, "public"))); app.use(session({ secret: "cats", resave: false, saveUninitialized: false })); app.use(passport.session()); app.use(express.urlencod

Apr 20, 2025 - 23:59
 0
¿Cómo ejecutar Node.js, PostgreSQL y Express.js en contenedores dentro de un entorno de desarrollo?

Si no quieres depender de algún entorno de desarrollo integrado (IDE) en la nube (GitHub Codespaces, Firebase Studio, Replit, etc) la clave es usar Docker, Docker Compose, Git, y un repositorio en la nube como GitHub, GitLab o Bitbucket.

Descripción general:

Este tutorial consiste en Dockerizar una aplicación Backend de Node.js y una base de datos de PostgresSQL, controlando todo el stack de la aplicación con un solo archivo. Los temas cubiertos incluye:

  • Ejecutar PostgresSQL, Adminer en un contenedor local.
  • Conterizar aplicación Node.js.
  • Configurar archivo Docker Compose y Dockerfile.

Definiciones.

  • Docker
    Dado que Docker está disponible y es compatible con Linux, macOS y Windows, la mayoría del software puede ser utilizado en cualquier computadora. Docker simplifica y flexibiliza el proceso de configuración de la aplicación, permitiéndole implementar, administrar y escalar bases de datos en contenedores aislados con solo unos pocos comandos.

  • Docker Compose
    Docker Compose simplifica el control de toda tu stack de aplicaciones, lo que facilita la gestión de servicios, redes y volúmenes en un único archivo de configuración YAML comprensible. Luego, con un solo comando, puedes crear y iniciar todos los servicios desde tu archivo de configuración.

  • Git
    Es un sistema de control de versiones que permite a los desarrolladores guardar diferentes versiones de archivos y rastrear los cambios realizados en un proyecto.

  • GitHub
    Es una plataforma basada en la nube que aloja repositorios de código y facilita la colaboración entre desarrolladores, permitiendo que trabajen en proyectos simultáneamente y mantengan un seguimiento de los cambios.

Requisitos:

  • Instalar Docker.
  • Instalar Docker Compose.
  • Instalar Node.js.
  • Instalar Git.
  • Una cuenta de GitHub.

Si clonas el repositorio de GitHub, ve al Paso 2 - Dockeriza la aplicación..

Paso 1 - Crea el proyecto local.

A continuación, se va a describir cómo crear la app con Node.js sin Docker, con una breve explicación de cada una de sus partes.

1. Crea el directorio del proyecto:

Pega los siguientes comandos en tu terminal:

mkdir members-only
cd  members-only

2. Crea los archivos y directorios de la aplicación:

Pega los siguientes comandos en tu terminal:

mkdir src controllers db middleware public routes views
touch package.json

3. Configurar tu package.json:

En el package.json pega lo siguiente:

{
  "name": "docker-compose",
  "version": "1.0.0",
  "private": true,
  "main": "src/app.js",
  "keywords": [],
  "author": "",
  "license": "ISC",
  "description": "",
  "scripts": {
    "start": "nodemon src/app.js",
    "deploy": "node src/app.js",
    "formatter": "semistandard --fix"
  },
  "dependencies": {
    "bcrypt": "5.1.1",
    "dotenv": "16.4.7",
    "ejs": "3.1.10",
    "express": "4.21.2",
    "express-session": "1.18.1",
    "express-validator": "7.2.1",
    "passport": "0.7.0",
    "passport-local": "1.0.0",
    "pg": "8.13.3"
  },
  "devDependencies": {
    "nodemon": "3.1.9",
    "semistandard": "17.0.0"
  },
  "eslintConfig": {
    "extends": [
      "./node_modules/semistandard/eslintrc.json"
    ]
  },
  "nodemonConfig": {
    "watch": [
      "src"
    ],
    "ignore": [
      "*.test.ts"
    ],
    "delay": "3",
    "execMap": {
      "ts": "ts-node"
    }
  }
}

IMPORTANTE: Debido a que la aplicación se ejecutará dentro de un contenedor, Te recomiendo utilizar nodemon en lugar de node --watch. Este último presenta inestabilidad en contenedores, ya que solo detecta modificaciones en los archivos una única vez y deja de monitorearlos posteriormente.

Explicando package.json:

"main": "src/app.js", El archivo principal es src/app.js.
“scripts”:
start: Corre la app con nodemon (modo desarrollo).
deploy: Corre la app en producción
formatter: Formatea el código con semistandard.

“Dependencies”:

express: Servidor web.
ejs: Plantillas HTML.
dotenv: Variables de entorno.
bcrypt: Encriptación.
passport / passport-local: Autenticación.
express-session: Manejo de sesiones.
express-validator: Validación de datos.
pg: Conexión a PostgreSQL.

“devDependencies”:
nodemon: Recarga automática en desarrollo.
semistandard: Reglas de estilo.

nodemon observa src/, ignora .test.ts, espera 3 segundos para reiniciar.

4. Configura app.js.

Crea el archivo app.js en el directorio src:

touch src/app.js

Pega el siguiente código en src/app.js:

const path = require("node:path");
const express = require("express");

const session = require("express-session");
const passport = require("passport");

const routes = require("./routes/index.js")

const app = express();

app.set("views", path.join(__dirname, "views"));
app.set("view engine", "ejs");

app.use(express.static(path.join(__dirname, "public")));

app.use(session({ secret: "cats", resave: false, saveUninitialized: false }));
app.use(passport.session());
app.use(express.urlencoded({ extended: false }));

// routes
app.use(routes);

const PORT = process.env.PORT_NODE_SERVER ?? 3000;
const IP_NODE_SERVER = process.env.IP_NODE_SERVER ?? "localhost";

app.listen(PORT, () => {
  console.log(`http://${IP_NODE_SERVER}:${PORT}`);
});

Importa módulos:
path: Manejo de rutas de archivos.
express: Framework del servidor.
express-session: Manejo de sesiones.
passport: Autenticación.
routes: Rutas de la aplicación.

Inicializa Express:
Crea una instancia de la app (app).

Configuración del motor de vistas:
Las vistas están en ./views.

Usa EJS para renderizar HTML dinámico.

Archivos estáticos:
Sirve archivos desde la carpeta ./public.

Sesiones y autenticación:
Usa express-session con una clave secreta.
Configura passport para manejar la sesión.
Acepta formularios codificados (urlencoded).

Define rutas:
Carga las rutas desde ./routes/index.js.

Servidor:
Usa el puerto y la IP de las variables de entorno o por defecto localhost:3000.

Aun el proyecto no funcionara, falta crear la base de datos, las consultas, las rutas y las vistas

5. Routes

Pega el siguiente código en routes/index.js:

const express = require("express");

const indexController = require("../controllers/indexController.js");
const loginInController = require("../controllers/logInController.js");
const logOutController = require("../controllers/logOutController.js");
const memberJoinController = require("../controllers/memberJoinController.js");
const signUpController = require("../controllers/signUpController.js");
const createMsgController = require("../controllers/createMsgController.js");

const middlewareSignUpValidation = require("../middleware/validation/signUpValidation.js");
const middlewareCreateMsgValidation = require("../middleware/validation/createMsgValidation.js");

const router = express.Router();

router.get("/", indexController.getIndex);
router.get("/log-in", loginInController.getLoginForm);
router.get("/sign-up", signUpController.getSignupForm);
router.get("/log-out", logOutController.getLogout);
router.get("/member-join", memberJoinController.getMemberJoinForm);
router.get("/create-msg", createMsgController.getCreateMsgForm );


router.post(
  "/sign-up",
  middlewareSignUpValidation.validateUser(),
  signUpController.create
);

router.post(
  "/log-in",
  loginInController.passportLocalStrategy.authenticate("local", {
    successRedirect: "/",
    failureRedirect: "/log-in",
  })
);

router.post("/member-join", memberJoinController.confirmSecretAccess);

router.post("/create-msg", middlewareCreateMsgValidation.validateMsg(), createMsgController.create);

router.all("*", (req, res) => {
  if (req.isAuthenticated()) {
    res.status(404).render("404");
  } else {
    res.redirect("/log-in");
  }
});

module.exports = router;

Aquí es donde se organiza las rutas de la aplicación y asigna un controlador. Cuando el usuario accede a una ruta (por ejemplo, inicio, ingreso, registro o creación de mensajes), se invoca el controlador correspondiente para generar el formulario o la vista.

6. BD

En src/bd/pool.js pega el siguiente codigo:

const { Pool } = require("pg");

require("dotenv").config();

const pool = new Pool({
  host: process.env.HOSTS_DB, // or wherever the db is hosted
  port: process.env.PORT_DB,
  user: process.env.USER_DB,
  password: process.env.PASSWORD_DB,
  database: process.env.DATABASE_DB, // The default port
});

module.exports = pool;

En src/db/query.js pega el siguiente código:

const pool = require("./pool.js");

async function getAllTable(table) {
  const { rows } = await pool.query(`SELECT * FROM ${table};`);
  return rows;
}

async function getAllmsg() {
  const { rows } = await pool.query(
    `SELECT u.username, m.date, m.description, m.title FROM logs_messages m INNER JOIN users u ON u.id = m.user_id;`
  );
  return rows;
}

async function getSecretCode(username) {
  const { rows } = await pool.query(
    `SELECT username FROM users WHERE username = '${username}';`
  );
  // console.log(rows);

  return rows.map((x) => x.username).toString();
}

async function updateStatusMember(id, secretCode) {
  const { rows } = await pool.query(
    `UPDATE users 
     SET is_member = true
     WHERE id = '${id}' AND username = '${secretCode}';`
  );

  return rows;
}

async function insertMsg (id, title, description) {
  const { rows } = await pool.query(
    "insert into logs_messages (user_id, title, description) values ($1, $2, $3)",
    [id, title, description]
  );

  return rows;
}

module.exports = {
  getAllTable,
  getAllmsg,
  getSecretCode,
  updateStatusMember,
  insertMsg,
};
  • pool.js crea y exporta un pool de conexiones a PostgreSQL.
  • query.js – ejecuta consultas SQL. ### 7. Controlladores 
touch createMsgController.js logInController.js memberJoinController.js indexController.js logOutController.js signUpController.js

En src/controllers/createMsgController.js pega el siguiente codigo:

const db = require("../db/query");
const bcrypt = require("bcrypt");

async function getCreateMsgForm(req, res) {
  if (req.isUnauthenticated()) {
    res.redirect("/");
  } else {
    res.render("pages/create-msg.ejs");
  }
}

async function create(req, res, next) {
  try {
    const insert = await db.insertMsg(
      req.user.id,
      req.body.title,
      req.body.description
    );

    insert

    res.redirect("/");
  } catch (error) {
    console.error(error);
    next(error);
  }
}

module.exports = { getCreateMsgForm, create };

En src/controllers/logInController.js pega el siguiente codigo:

const db = require("../db/query.js");
const passportLocalStrategy = require("../middleware/passportLocalStrategy.js");

async function getLoginForm(req, res) {
  if (req.user !== undefined) res.redirect("/");
  const messages = await db.getAllmsg();
  if (req.isUnauthenticated()) {
    res.render("pages/log-in.ejs");
  } else {
    res.render("pages/index.ejs", { messages, user: req.user });
  }
}

function handleForm(req, res, next) {}

module.exports = { getLoginForm, handleForm, passportLocalStrategy };

En src/controllers/memberJoinController.js pega el siguiente codigo:

const db = require("../db/query.js");
// const passportLocalStrategy = require("../middleware/passportLocalStrategy.js");

async function getMemberJoinForm(req, res) {

  if (req.isUnauthenticated() || req.user.is_member) {
    res.redirect("/");
  } else {
    res.render("pages/memberJoin.ejs");
  }

}

async function confirmSecretAccess(req, res) {
  try {
    const getSecret = await db.getSecretCode(req.body.secretCode);

    if (!req.user.is_member) {
      await db.updateStatusMember(req.user.id, req.body.secretCode);
    }

    if (req.body.secretCode !== getSecret) {
      return res.render("pages/memberJoin.ejs", {
        incorrect: "secret code incorrect!!!!",
      });
    }

    res.redirect("/");

  } catch (error) {
    console.error("Error in confirmSecretAccess:", error);
    res.status(500).send("Internal Server Error");
  }
}


module.exports = { getMemberJoinForm, confirmSecretAccess };

En src/controllers/indexController.js pega el siguiente codigo:

const db = require("../db/query.js");

async function getIndex(req, res) {
  const messages = await db.getAllmsg();

  if (req.isUnauthenticated()) {
    res.render("pages/index.ejs", { messages });
  } else {
    // console.log(req)
    res.render("pages/index.ejs", { user: req.user, messages });
  }

}

module.exports = { getIndex };

En src/controllers/logOutController.js pega el siguiente codigo:

async function getLogout(req, res, next) {
  req.logout((err) => {
    if (err) {
      return next(err);
    }
    res.redirect("/");
  });
}
module.exports = { getLogout }

En src/controllers/signUpController.js pega el siguiente codigo:

const pool = require("../db/pool.js");
const bcrypt = require("bcrypt");

async function getSignupForm(req, res) {
  if (req.isUnauthenticated()) {
    res.render("pages/sign-up-form.ejs");
  } else {
    res.redirect("/");
  }
}

async function create(req, res, next) {
  try {
    const hashedPassword = await bcrypt.hash(req.body.password, 10);
    await pool.query(
      "insert into users (username, password, first_name, last_name) values ($1, $2, $3, $4)",
      [
        req.body.username,
        hashedPassword,
        req.body.first_name,
        req.body.last_name,

      ]
    );
    // AUTHENTICATE
    res.redirect("/log-in");
  } catch (error) {
    console.error(error);
    next(error);
  }


}

module.exports = { getSignupForm, create };

8. Middleware

Pega los siguientes comandos en tu terminal:

mkidr src/middleware/validation
touch src/middleware/passportLocalStrategy.js  src/middleware/validation/createMsgValidation.js  src/middleware/validation/signUpValidation.js

En src/middleware/passportLocalStrategy.js pega el siguiente codigo:

const pool = require("../db/pool.js");
const passportLocalStrategy = require("passport");
const LocalStrategy = require("passport-local").Strategy;
const bcrypt = require("bcrypt");

passportLocalStrategy.use(
  new LocalStrategy(async (username, password, done) => {
    try {
      const { rows } = await pool.query(
        "SELECT * FROM users WHERE username = $1",
        [username]
      );
      const user = rows[0];

      if (!user) {
        return done(null, false, { message: "Incorrect username" });
      }

      const match = await bcrypt.compare(password, user.password);
      if (!match) {
        // passwords do not match!
        return done(null, false, { message: "Incorrect password" });
      }

      // if (user.password !== password) {
      //   return done(null, false, { message: "Incorrect password" });
      // }
      return done(null, user);
    } catch (err) {
      return done(err);
    }
  })
);

passportLocalStrategy.serializeUser((user, done) => {
  done(null, user.id);
});

passportLocalStrategy.deserializeUser(async (id, done) => {
  try {
    const { rows } = await pool.query("SELECT * FROM users WHERE id = $1", [
      id,
    ]);

    const user = rows[0];

    done(null, user);
  } catch (err) {
    done(err);
  }
});


module.exports = passportLocalStrategy;

En src/middleware/validation/createMsgValidation.js pega el siguiente codigo:

const { body, oneOf, validationResult } = require("express-validator");


const leastOneErr =
  "At least one valid name field (title, description)  must be provided";

const validateMsg = () => {
  return [
    oneOf(
      [
        body("title")
          .trim() /*.isEmpty()*/
          .isLength({ max: 500 }),
        body("description")
          .trim() /*.isEmpty()*/
          .isLength({ max: 255 }),
      ],
      { message: `${leastOneErr}` }
    ),

    (req, res, next) => {
      const errors = validationResult(req);
      if (!errors.isEmpty()) {
        const checkError = errors.array().map((error) => error.msg);

        res.status(400).json({
          msg: checkError,
        });

        return;
      }
      next();
    },
  ];
};

module.exports = { validateMsg };

En src/middleware/validation/signUpValidation.js pega el siguiente codigo:

const { body, oneOf, validationResult } = require("express-validator");


const leastOneErr =
  "At least one valid name field (first_name, last_name, or username) must be provided";

const validateUser = () => {
  return [
    oneOf(
      [
        body("first_name").trim()/*.isEmpty()*/.isLength({ max: 50 }),
        body("last_name").trim()/*.isEmpty()*/.isLength({ max: 50 }),
        body("username").trim()/*.isEmpty()*/.isLength({ max: 255 }),
      ],
      { message: `${leastOneErr}` }
    ),
    body("password")
      .trim()
      // .isEmpty()
      .isLength({ max: 255 })
      .withMessage(`Password invalid`),
    body("passwordConfirmation")
      .trim()
      .custom((value, { req }) => {
        return value === req.body.password;
      })
      .withMessage(`password must match`),

    (req, res, next) => {
      const errors = validationResult(req);
      if (!errors.isEmpty()) {
        const checkError = errors.array().map((error) => error.msg);

        res.status(400).json({
          msg: checkError,
        });

        return;
      }
      next();
    },
  ];
};

module.exports = { validateUser };

9. Estilos y vistas 

mkdir src/views/pages src/views/partials
touch src/views/pages/create-msg.ejs  src/views/pages/index.ejs   src/views/pages/log-in.ejs src/views/pages/memberJoin.ejs src/views/pages/sign-up-form.ejs src/views/partials/footer.ejs  src/views/partials/nav.ejs src/views/sign-up-form.ejs

En src/views/pages/create-msg.ejs pega el siguiente codigo:


 lang="en">


   charset="UTF-8" />
   http-equiv="X-UA-Compatible" content="IE=edge" />
   name="viewport" content="width=device-width, initial-scale=1.0" />
  </span>Create Messages<span class="nt">
   rel="stylesheet" href="css/base.css" />
   rel="stylesheet" href="css/pages/create-msg.css" />  



   class="container">
     class="login-card">

       class="title">Create Message

       action="/create-msg" method="POST">
         class="input-group">
           for="title">Title
           id="title" name="title" placeholder="title" type="text" required />
class="input-group"> for="description">Description name="description" id="description" required>
class="btn-form"> class="btn" type="submit">Send