0.0.15 • Published 7 months ago

monobase-server v0.0.15

Weekly downloads
-
License
MIT
Repository
-
Last release
7 months ago

Monobase Server

Monobase Server es un sistema de base de datos y servidor de código abierto diseñado para ser similar a Firebase, pero utiliza MongoDB como base de datos en un servidor Express preconfigurado. Esta plataforma incluye React para la interfaz de usuario (UI), Mongoose para la gestión de la base de datos y Socket.io para la comunicación en tiempo real.

Características clave

  • Base de datos MongoDB: Monobase Server utiliza MongoDB como sistema de almacenamiento de datos, lo que proporciona una escalabilidad y flexibilidad excepcionales para tus aplicaciones.

  • Express.js: Está construido sobre Express.js, un popular marco de aplicación web para Node.js, lo que facilita la configuración y personalización del servidor.

  • Interfaz de usuario basada en React: Monobase Server integra React para crear una interfaz de usuario dinámica y receptiva.

  • Gestión de modelos Mongoose en tiempo de ejecución: Esta característica permite la creación sencilla de esquemas de Mongoose a través de una interfaz de usuario y construye modelos de Mongoose en tiempo de ejecución para consultas eficientes.

  • REST API and Socket.io: Proporciona acceso a la información a través de una API REST y Socket.io, lo que permite la comunicación en tiempo real entre el cliente y el servidor.

Instalación

Para comenzar a usar Monobase Server en tu proyecto, puedes instalarlo fácilmente a través de npm:

npm install monobase-server

Uso

Para utilizar Monobase Server en tu aplicación, sigue estos pasos:

  1. Importa Monobase Server en tu aplicación:

    const { MonoServer } = require("monobase-server");
  2. Configura y personaliza las opciones de Monobase Server según tus necesidades:

    const server = new MonoServer({
     __dirname,
     secretAuth: process.env.SECRET_TOKENT as string,
     secretVerify: process.env.SECRET_VERIFY as string,
     apiKey: process.env.APIKEY as string,
     logs: console.log
    });
  3. Inicia Monobase Server en tu servidor Express:

     // Importante: Escucha el servidor con la configuración especificada
     server.listen({
         version: "v1", // Versión del servidor
    
         server: {
             hostname: "localhost", // Nombre de host del servidor (puede ser un valor diferente en producción)
             port: process.env.PORT as unknown as number // Puerto en el que se ejecutará el servidor
         },
    
         mongodb: {
             /*
             // Datos de conexión a MongoDB en producción
             */
             production: {
                 username: process.env.MONGO_USERNAME as string, // Nombre de usuario de MongoDB
                 password: process.env.MONGO_PASSWORD as string, // Contraseña de MongoDB
                 cluster: process.env.MONGO_CLUSTER as string, // Cluster de MongoDB
                 dbname: process.env.MONGO_DBNAME as string // Nombre de la base de datos de MongoDB
             },
    
             /*
             // Datos de conexión a MongoDB en entorno local (desarrollo)
             */
             local: {
                 hostname: "localhost", // Nombre de host local de MongoDB
                 port: 27017, // Puerto de MongoDB en el entorno local
                 dbname: "monobase" // Nombre de la base de datos local de MongoDB
             }
         },
    
         socket: {
             apiKey: process.env.APIKEY_SOCKET as string, // Clave de la API del socket
             secret: process.env.SECRET_SOCKET as string // Secreto del socket para autenticación
         }
     });

We hope Monobase Server proves to be a valuable tool for your project! If you have any questions or encounter any issues, don't hesitate to contact us at contact@youremail.com. Thank you for using Monobase Server!