Acortador de Links

Dentro de Mars Society Argentina tenemos la necesidad de compartir enlaces a nuestras publicaciones, eventos, redes sociales, entre otras cosas, para lo cual contar con links breves y fáciles de recordar, resulta de gran ayuda.

Para esto contamos con el dominio https://tmsa.ar que funciona como acortador de vínculos. Por defecto redirige el tráfico a nuestra página web sin embargo a través de este repositorio es posible agregar nuevos enlaces de acceso rápido, en muy poco tiempo.

Instalación

Para instalar este repositorio y poder agregar nuevos enlaces, deberás seguir los siguientes pasos:

0. Preparación

Antes de comenzar necesitarás tener Git y Node.js instalados. Se sugiere que a la hora de instalar Git en Windows, el comando git esté disponible desde la terminal Cmd.

Para saber si Git y Node.js están correctamente instalados se pueden usar los siguientes comandos:

git --version
node --version

Una vez instalados, deberás configurar las llaves SSH para poder pushear el código a GitHub, usando Git. Este proceso es complejo así que deberás seguir los tutoriales del enlace.

1. Clonar

El primer paso de la instalación será clonar el repositorio.

Es importante que lo clones, y no lo descargues.

Al momento de clonar, se creará una carpeta con el nombre del repositorio, en el directorio actual. El comando a usar es el siguiente:

git clone git@github.com:MarsArgentina/tmsa.ar.git

2. Instalar Paquetes

Una vez clonado el repositorio ingresamos a la carpeta:

cd tmsa.ar

Y una vez allí deberemos instalar los paquetes usando NPM:

npm install

Con esto nuestro repositorio se encontrará instalado correctamente.

3. Link

El siguiente comando, crea un ejecutable tmsa que estará disponible en cualquier directorio. Este paso es opcional pero recomendado.

npm link

Uso

Si seguiste el paso 3

Si has seguido el paso 3 podrás correr el siguiente comando en cualquier terminal:

tmsa [link] [name]

Esto acortará el link a https://tmsa.ar/name

Si NO seguiste el paso 3

Para usar el comando deberás abrir una terminal en la carpeta del proyecto y correr el siguiente comando:

npm run shorten [link] [name]

Esto acortará el link a https://tmsa.ar/name

Licencia

Este proyecto es una instancia de Netlify Shortener por lo que la licencia de este proyecto es MIT, y el Copyright es de Kent C. Dodds