Cómo automatizar la implementación de una aplicación de publicación de blog con GitHub Actions, Node.js, CouchDB y Aptible

Bienvenido a la guía sobre cómo automatizar la implementación de una aplicación de publicación de blog usando GitHub Actions, Node.js,

CouchDB y Aptible.

Este completo tutorial lo guiará en la creación, implementación y administración de una aplicación de publicación de blog utilizando las herramientas y tecnologías mencionadas anteriormente.

Pero primero, déjame darte una breve descripción de la aplicación Blogpost , lo que hace y sus componentes principales. La aplicación Blogpost es una aplicación web que permite a los usuarios crear y compartir publicaciones de blog.

Los usuarios pueden escribir, editar, eliminar y ver publicaciones de otros usuarios. La aplicación utiliza Node.js como backend, CouchDB como base de datos y GitHub Actions como herramienta de integración e implementación continua.

¿Por qué elegí estos? Bueno, hay muchas razones, pero estas son algunas de las principales:

• Node.js es un entorno de ejecución de JavaScript rápido, escalable y fácil de usar que puede ejecutarse en varias plataformas. Tiene muchas bibliotecas y marcos para el desarrollo web, como Express, un marco de aplicación web minimalista y flexible que usaré en este proyecto.

• CouchDB es un sistema de base de datos NoSQL de código abierto que es confiable, seguro y potente. Es una base de datos orientada a documentos que utiliza JSON para almacenar datos.

• GitHub Actions es una herramienta flexible, conveniente e integrada que le permite automatizar flujos de trabajo para sus repositorios de GitHub. También tiene muchas acciones prediseñadas que puede usar o personalizar según sus necesidades, como la acción Aptible Deploy, que usaré en este proyecto para implementar la aplicación en Aptible.

• Aptible es una plataforma basada en la nube para implementar y administrar aplicaciones en contenedores, que proporciona capacidades sencillas de aprovisionamiento, escalamiento y monitoreo.

Requisitos previos

Antes de comenzar el viaje del desarrollo, es esencial configurar las herramientas y tecnologías necesarias.

• Node.js: asegúrese de que Node.js esté instalado en su máquina.

• CouchDB: Verifique que CouchDB esté instalado y ejecutándose en su sistema.

• Experiencia en Node.js y JavaScript: poseer una sólida comprensión de los fundamentos de Node.js y JavaScript.

• Docker: instale y ejecute Docker en su máquina.

• Cuenta Aptible: cree una cuenta Aptible y familiarícese con la implementación de una aplicación básica.

• Cuenta Docker Cloud: Adquiera una cuenta Docker Cloud para alojar sus aplicaciones.

Desarrollo de la aplicación Blogpost

1: Configure su proyecto Node.js

• Cree un directorio de proyectos para su aplicación de publicación de blog.

• Inicialice un proyecto Node.js usando npm:

 npm init -y

• Instale el marco Express.js, que servirá como base para el backend:

 npm install express nano

Paso 2: configurar CouchDB

• Asegúrese de que CouchDB esté instalado y ejecutándose. Puede acceder a CouchDB a través de su navegador en http://127.0.0.1:5984/_utils/ .

Paso 3: cree su aplicación Node.js

• Cree un archivo blog.js en el directorio de su proyecto.

• Inicialice Express y conéctelo a CouchDB:

 const express = require("express"); const nano = require("nano")("http://admin:[email protected]:5984"); const app = express(); const port = 3000; // Middleware to parse JSON data app.use(express.json()); // async function asyncCall() { // // await nano.db.destroy("alice"); // await nano.db.create("blogposts"); // const db = nano.use("blogposts"); // return response; // } // asyncCall(); const db = nano.use("blogposts");

• Este código define puntos finales de API para crear, recuperar, actualizar y eliminar publicaciones de blog utilizando una base de datos CouchDB.

  
  

 // Create a new blog post app.post("/posts", async (req, res) => { const { title, description, author } = req.body; try { const doc = await db.insert({ title, description, author, createdAt: new Date(), updatedAt: new Date(), }); res.json({ id: doc.id, rev: doc.rev }); } catch (err) { console.error(err); res.status(500).send("Error creating post"); } }); // Get all blog posts app.get("/posts", async (req, res) => { try { const docs = await db.list({ include_docs: true }); res.json(docs.rows); } catch (err) { console.error(err); res.status(500).send("Error retrieving posts"); } }); // Get a specific blog post app.get("/posts/:id", async (req, res) => { const { id } = req.params; try { const doc = await db.get(id); res.json(doc); } catch (err) { console.error(err); res.status(404).send("Post not found"); } }); // Update a blog post app.put("/posts/:id", async (req, res) => { const { id } = req.params; const { title, description } = req.body; try { await db.insert({ _id: id, title, description, updatedAt: new Date(), }); res.json({ message: "Post updated successfully" }); } catch (err) { console.error(err); res.status(500).send("Error updating post"); } }); // Delete a blog post app.delete("/posts/:id", async (req, res) => { const { id } = req.params; try { await db.destroy(id); res.json({ message: "Post deleted successfully" }); } catch (err) { console.error(err); res.status(500).send("Error deleting post"); } }); app.listen(port, () => { console.log(`Blogpost app listening on port ${port}`); });

Probándolo localmente:

Las pruebas exhaustivas son cruciales para garantizar la funcionalidad y solidez de su proyecto. Aquí hay una documentación API de muestra para guiar su proceso de prueba:

Documentación API

URL base :

Suponiendo que su servidor se esté ejecutando localmente en el puerto 3000, la URL base para su API sería:

 http://localhost:3000

Puntos finales de API:

Crear una nueva publicación de blog

• Punto final : POST /posts

• Descripción : Crea una nueva publicación de blog.

• Cuerpo de la solicitud :

   { "title": "String", "description": "String", "author": "String" }

• Ejemplo :

   POST http://localhost:3000/posts { "title": "Sample Title", "description": "Sample Description", "author": "John Doe" }

Obtener todas las publicaciones del blog

• Punto final : GET /posts

• Descripción : recupera todas las publicaciones del blog.

• Respuesta :

   [ { "id": "String", "key": "String", "value": { "rev": "String" }, "doc": { "_id": "String", "_rev": "String", "title": "String", "description": "String", "author": "String", "createdAt": "Date", "updatedAt": "Date" } } ]

• Ejemplo :

   GET http://localhost:3000/posts

Obtenga una publicación de blog específica

• Punto final : GET /posts/:id

• Descripción : recupera una publicación de blog específica por su ID.

• Parámetros :

  • id : ID de la publicación del blog.

• Respuesta :

   { "_id": "String", "_rev": "String", "title": "String", "description": "String", "author": "String", "createdAt": "Date", "updatedAt": "Date" }

• Ejemplo :

   GET http://localhost:3000/posts/your-post-id

Actualizar una publicación de blog

• Punto final : PUT /posts/:id

• Descripción : actualiza una publicación de blog específica por su ID.

• Parámetros :

  • id : ID de la publicación del blog.

• Cuerpo de la solicitud :

   { "title": "String", "description": "String" }

• Ejemplo :

   PUT http://localhost:3000/posts/your-post-id { "title": "Updated Title", "description": "Updated Description" }

Eliminar una publicación de blog

• Punto final : DELETE /posts/:id

• Descripción : Elimina una publicación de blog específica por su ID.

• Parámetros :

  • id : ID de la publicación del blog.

• Ejemplo :

   DELETE http://localhost:3000/posts/your-post-id

Reemplace your-post-id con una ID real de la publicación del blog cuando pruebe las solicitudes GET , PUT y DELETE .

Paso 4: Dockerize su aplicación Node.js

Debe tener una cuenta de Docker Hub. Si aún no ha creado uno, regístrese en Docker Hub.

Pasos para enviar la aplicación Dockerizada a Docker Hub:

• Cree un Dockerfile en el directorio raíz de su proyecto Node.js.

 # Use an official Node.js runtime as the base image FROM node:16 # Set the working directory in the container WORKDIR /usr/src/app # Copy package.json and package-lock.json to the working directory COPY package*.json ./ # Install app dependencies RUN npm install # Copy the rest of the application files to the working directory COPY . . # Expose the port the app runs on EXPOSE 3000 # Define the command to run the app CMD ["node", "blog.js"]

• Etiquete su imagen de Docker: abra su terminal/símbolo del sistema y navegue hasta el directorio raíz de su aplicación Node.js, donde se encuentra su Dockerfile.

  
  

Ejecute el siguiente comando para crear su imagen de Docker y etiquétela con su nombre de usuario de Docker Hub y el nombre del repositorio deseado:

 docker build -t your-docker-username/blogpost-app:latest .

Reemplace your-docker-username con su nombre de usuario de Docker Hub y blogpost-app con el nombre de repositorio que desee.

Obtendrá una respuesta similar a esta:

 [+] Building 1.1s (10/10) FINISHED docker:desktop-linux => [internal] load .dockerignore 0.0s => => transferring context: 2B 0.0s => [internal] load build definition from Dockerfile 0.0s => => transferring dockerfile: 489B 0.0s => [internal] load metadata for docker.io/library/node:16 1.0s => [1/5] FROM docker.io/library/node:16@sha256:f77a1aef2da8d83e45ec990f45df50f1a286c5fe8bbfb8c6e4246c6389705c0b 0.0s => [internal] load build context 0.0s => => transferring context: 45.31kB 0.0s => CACHED [2/5] WORKDIR /usr/src/app 0.0s => CACHED [3/5] COPY package*.json ./ 0.0s => CACHED [4/5] RUN npm install 0.0s => CACHED [5/5] COPY . . 0.0s => exporting to image 0.0s => => exporting layers 0.0s => => writing image sha256:c5f046a9b99389aea6bf3f503e9b05cce953daf1b3f77ee5fb3f7469dc36c709 0.0s => => naming to docker.io/wise4rmgod/blogpost-app:latest

• Inicie sesión en Docker Hub: autentique su cliente Docker con su cuenta de Docker Hub ejecutando el siguiente comando:

 docker login

Ingrese su nombre de usuario y contraseña de Docker Hub cuando se le solicite.

 Authenticating with existing credentials... Login Succeeded

• Envíe la imagen de Docker a Docker Hub: una vez que haya iniciado sesión, envíe su imagen de Docker etiquetada a su repositorio de Docker Hub usando el siguiente comando:

 docker push your-docker-username/blogpost-app:latest

Este comando carga su imagen local en Docker Hub en su repositorio especificado.

• Verifique el envío: vaya a su cuenta de Docker Hub en la web y navegue hasta su repositorio para confirmar que su imagen de Docker se haya enviado correctamente.

  

  
  

 aptible deploy --app reactgame --docker-image wise4rmgod/blogpost-app --private-registry-username wise4rmgod --private-registry-password H$(_tS+W~ZBST63

Paso 5: Implementación apto

• Inicie sesión en Aptible a través de CLI usando el siguiente comando:

 aptible login

Se le pedirá que ingrese su correo electrónico y contraseña. Si tiene éxito, recibirá una respuesta similar a esta:

 Token written to /Users/wisdomnwokocha/.aptible/tokens.json This token will expire after 6 days, 23 hrs (use --lifetime to customize)

• Ahora, implemente su aplicación usando el siguiente comando:

Sintaxis:

 aptible deploy --app <app name> --docker-image <docker image in cloud>

Aquí hay un comando de ejemplo:

 aptible deploy --app reactgame --docker-image wise4rmgod/blogpost-app

Recibirá una respuesta similar a la siguiente:

 INFO -- : Starting App deploy operation with ID: 61135861 INFO -- : Deploying without git repository INFO -- : Writing .aptible.env file... INFO -- : Fetching app image: wise4rmgod/blogpost-app... INFO -- : Pulling from wise4rmgod/blogpost-app INFO -- : 26ee4ff96582: Pulling fs layer INFO -- : 446eab4103f4: Pulling fs layer INFO -- : 2e3c22a0f840: Pulling fs layer INFO -- : a7ab8ad9b408: Pulling fs layer INFO -- : 3808fdf0c601: Pulling fs layer INFO -- : ab9e4075c671: Pulling fs layer INFO -- : 362360c8cef6: Pulling fs layer INFO -- : 928b5d11ac66: Pulling fs layer INFO -- : dc87e077ac61: Pulling fs layer INFO -- : f108e80f4efc: Pulling fs layer INFO -- : 84ac53840ac8: Pulling fs layer INFO -- : e81f21b79a1f: Pulling fs layer INFO -- : 2e3c22a0f840: Downloading: 523 KB / 49.8 MB INFO -- : 446eab4103f4: Downloading: 173 KB / 16.6 MB INFO -- : 26ee4ff96582: Downloading: 483 KB / 47 MB INFO -- : 2e3c22a0f840: Downloading: 25.7 MB / 49.8 MB INFO -- : a7ab8ad9b408: Downloading: 528 KB / 175 MB INFO -- : ab9e4075c671: Downloading: 355 KB / 33.4 MB INFO -- : a7ab8ad9b408: Downloading: 35.3 MB / 175 MB INFO -- : 26ee4ff96582: Pull complete INFO -- : 446eab4103f4: Pull complete INFO -- : 2e3c22a0f840: Pull complete INFO -- : a7ab8ad9b408: Downloading: 71.2 MB / 175 MB INFO -- : a7ab8ad9b408: Downloading: 106 MB / 175 MB INFO -- : a7ab8ad9b408: Downloading: 142 MB / 175 MB INFO -- : a7ab8ad9b408: Pull complete INFO -- : 3808fdf0c601: Pull complete INFO -- : ab9e4075c671: Pull complete INFO -- : 362360c8cef6: Pull complete INFO -- : 928b5d11ac66: Pull complete INFO -- : dc87e077ac61: Pull complete INFO -- : f108e80f4efc: Pull complete INFO -- : 84ac53840ac8: Pull complete INFO -- : e81f21b79a1f: Pull complete INFO -- : Digest: sha256:de9d04d069ca89ebdb37327365a815c88cd40d90cbc5395cc31c351fff1206dd INFO -- : Status: Downloaded newer image for wise4rmgod/blogpost-app:latest INFO -- : No Procfile found in git directory or /.aptible/Procfile found in Docker image: using Docker image CMD INFO -- : No .aptible.yml found in git directory or /.aptible/.aptible.yml found in Docker image: no before_release commands will run INFO -- : Pushing image dualstack-v2-registry-i-0a5ec8cff8e775b34.aptible.in:46022/app-63213/72184c41-7dc6-4313-b10e-749125f72577:latest to private Docker registry... INFO -- : The push refers to repository [dualstack-v2-registry-i-0a5ec8cff8e775b34.aptible.in:46022/app-63213/72184c41-7dc6-4313-b10e-749125f72577] INFO -- : dd387bc6b362: Pushed INFO -- : 586bd9d5efcf: Pushed INFO -- : 8ae0c889ca84: Pushed INFO -- : c91ec53bcc27: Pushing: 522 KB / 93.6 MB INFO -- : aec897bac4f0: Pushed INFO -- : 0ead224631d3: Pushed INFO -- : ad3b30eb29d3: Pushing: 542 KB / 444 MB INFO -- : 2a7587eb01b6: Pushing: 544 KB / 137 MB INFO -- : be36d2a441aa: Pushed INFO -- : 03f6e3800bbe: Pushed INFO -- : a10e482288d1: Pushing: 338 KB / 30.7 MB INFO -- : f9cfc9f6b603: Pushing: 513 KB / 103 MB INFO -- : c91ec53bcc27: Pushing: 31.3 MB / 93.6 MB INFO -- : c91ec53bcc27: Pushing: 62.7 MB / 93.6 MB INFO -- : ad3b30eb29d3: Pushing: 44.5 MB / 444 MB INFO -- : 2a7587eb01b6: Pushing: 34.4 MB / 137 MB INFO -- : a10e482288d1: Pushed INFO -- : ad3b30eb29d3: Pushing: 88.9 MB / 444 MB INFO -- : f9cfc9f6b603: Pushing: 34.6 MB / 103 MB INFO -- : 2a7587eb01b6: Pushing: 68.9 MB / 137 MB INFO -- : ad3b30eb29d3: Pushing: 133 MB / 444 MB INFO -- : f9cfc9f6b603: Pushing: 70.2 MB / 103 MB INFO -- : c91ec53bcc27: Pushed INFO -- : 2a7587eb01b6: Pushing: 103 MB / 137 MB INFO -- : ad3b30eb29d3: Pushing: 178 MB / 444 MB INFO -- : ad3b30eb29d3: Pushing: 224 MB / 444 MB INFO -- : 2a7587eb01b6: Pushed INFO -- : f9cfc9f6b603: Pushed INFO -- : ad3b30eb29d3: Pushing: 270 MB / 444 MB INFO -- : ad3b30eb29d3: Pushing: 312 MB / 444 MB INFO -- : ad3b30eb29d3: Pushing: 355 MB / 444 MB INFO -- : ad3b30eb29d3: Pushing: 401 MB / 444 MB INFO -- : ad3b30eb29d3: Pushed INFO -- : latest: digest: sha256:de9d04d069ca89ebdb37327365a815c88cd40d90cbc5395cc31c351fff1206dd size: 2841 INFO -- : Pulling from app-63213/72184c41-7dc6-4313-b10e-749125f72577 INFO -- : Digest: sha256:de9d04d069ca89ebdb37327365a815c88cd40d90cbc5395cc31c351fff1206dd INFO -- : Status: Image is up to date for dualstack-v2-registry-i-0a5ec8cff8e775b34.aptible.in:46022/app-63213/72184c41-7dc6-4313-b10e-749125f72577:latest INFO -- : Image app-63213/72184c41-7dc6-4313-b10e-749125f72577 successfully pushed to registry. INFO -- : STARTING: Register service cmd in API INFO -- : COMPLETED (after 0.28s): Register service cmd in API INFO -- : STARTING: Derive placement policy for service cmd INFO -- : COMPLETED (after 0.15s): Derive placement policy for service cmd INFO -- : STARTING: Create new release for service cmd INFO -- : COMPLETED (after 0.24s): Create new release for service cmd INFO -- : STARTING: Schedule service cmd .. INFO -- : COMPLETED (after 13.49s): Schedule service cmd INFO -- : STARTING: Stop old app containers for service cmd INFO -- : COMPLETED (after 0.0s): Stop old app containers for service cmd INFO -- : STARTING: Start app containers for service cmd INFO -- : WAITING FOR: Start app containers for service cmd INFO -- : WAITING FOR: Start app containers for service cmd INFO -- : COMPLETED (after 18.4s): Start app containers for service cmd INFO -- : STARTING: Delete old containers for service cmd in API INFO -- : COMPLETED (after 0.0s): Delete old containers for service cmd in API INFO -- : STARTING: Commit app containers in API for service cmd INFO -- : COMPLETED (after 0.26s): Commit app containers in API for service cmd INFO -- : STARTING: Commit service cmd in API INFO -- : COMPLETED (after 0.13s): Commit service cmd in API INFO -- : STARTING: Cache maintenance page INFO -- : COMPLETED (after 0.28s): Cache maintenance page INFO -- : STARTING: Commit app in API INFO -- : COMPLETED (after 0.19s): Commit app in API INFO -- : App deploy successful.

• Visite el Panel de Aptible para confirmar que la implementación fue exitosa.

• Haga clic en la pestaña Punto final en el panel y guarde el punto final. Esto le permitirá exponer su base de datos a la Internet pública.

• Haga clic en Agregar punto final en la siguiente pantalla para crear un nuevo punto final.

Conclusión

Este tutorial completo lo ayudará a crear, implementar y administrar una aplicación de publicación de blog con Node.js, CouchDB y Aptible.

Ha comprendido los fundamentos de la configuración de las herramientas y tecnologías esenciales, la creación del backend de la aplicación de publicación del blog, la acoplabilidad de la aplicación, el envío de la imagen de Docker a Docker Hub y la implementación de la aplicación en Aptible.

¡Felicitaciones por completar este completo tutorial y su viaje hacia el desarrollo de aplicaciones nativas de la nube utilizando Aptible!