Instalación

meme.js es un SDK simple y versátil, por esto mismo, hay varias formas de empezar a usar nuestro SDK, y puedes usar la que más se adapte a tus necesidades, pero por supuesto, todas son fáciles de usar.

Aun así, y de momento verme, meme.js tiene un único requerimiento. Tener instalado previamente node v20.15.1 o superior de ser posible.

De igual forma les recomiendo que instalen las extensiones oficiales de meme.js.

meme.js Languages: El cual les ayudará a el coloreado de la sintaxis de los lenguajes que usaremos, además de los iconos básicos de los archivos propios de estos lenguajes.

meme.js Icons: Esta es una extensión completamente opcional y es un paquete de iconos de los archivos y carpetas del monorepo.

Manejar el paquete NPM

meme.js está disponible como un paquete de node por lo que lo podremos instalar en cualquier proyecto que necesitemos, por mi parte recomiendo instalarlo de forma global con lo que tendremos el CLI disponible en cualquier lugar.

Uso del SDK desde NPX

Todo el SDK pesa apenas 407KB (y estoy en la labor de reducir su tamaño aún más), por lo que es fácil usarlo sin instalación, con el comando npx meme-sdk, por ejemplo:

Inicializa un proyecto con:

npx meme-sdk init

Abre la carpeta de tu proyecto e inícialo con el siguiente comando:

npx meme-sdk start

Para detener los servicios de meme.js, lo haces con el comando:

npx meme-sdk stop -all

Instalación por proyecto

Si lo prefieres, puedes instalar el SDK como dependencia de tu proyecto de la siguiente manera:

Inicializa un proyecto con:

npx meme-sdk init -install

Abre la carpeta de tu proyecto e inícialo con el siguiente comando:

npx me start

Para detener los servicios de meme.js, lo haces con el comando:

npx me stop -all

Instalación global del SDK

Aunque existan las otras formas, te recomiendo que instales el SDK de forma global para facilitar muchas de las tareas y que el comando me, siempre esté disponible donde lo necesites.

Puedes instalar el SDK con NPM con el siguiente comando:

npm i -g meme-sdk

De esta forma tendremos disponible el CLI de meme.js en cualquier lugar, a través del comando me. Una vez instalado el SDK, lo podemos utilizar de la siguiente forma:

Inicializa un proyecto con:

me init

Abre la carpeta de tu proyecto e inícialo con el siguiente comando:

me start

Para detener los servicios de meme.js, lo haces con el comando:

me stop -all

Uso del monorepo de meme.js

meme.js no tiene ninguna clase de dependencias y está diseñado de forma desacoplada. Tanto entre los proyectos como en el mismo SDK, por lo mismo, puedes usarlo, solo clonando el repositorio.

Una vez que hayas clonado el monorepositorio, solo necesitas, ir a la carpeta del monorepo y ejecutar los siguientes comandos:

Inicializa un proyecto con:

./me init

Por supuesto, trabajar en el monorepo te da algunos beneficios extra, como por ejemplo el uso de los lanzadores de Visual Studio Code, que te servirán para iniciar los proyectos de forma rápida y sin comandos, además de levantar el entorno de depuración de todo tu proyecto.

Con solo clonar el monorepo, ya tendrás disponibles los lanzadores de los proyectos públicos de meme.js.
E igualmente cada vez que inicialices un proyecto dentro del monorepo. Se agregara un lanzador de VSCode referente a tu proyecto. Por lo que para ejecutarlo, puedes ir a la vista de Ejecución y depuración, buscar el lanzador de tu proyecto y dar click en el botón de iniciar depuración.