/shurly

Shurly es un acortador de links gratis y sin necesidad de registrarse :) (Cualquier feedback que tengas es bienvenido)

Primary LanguageJavaScript

Logo Shurly

Shurly es un acortador de urls gratis y lo mejor es que NO NECESITAS REGISTRARTE

🔨Funcionalidades del proyecto

  • 📌 Acortar urls: Ingresa un url largo y acortalo para que sea más fácil compartirlo con otros.
  • 📌 Detalles del url recortado: Muestra datos de tu link tales como:
    • ✔ Cantidad de clicks en el link
    • ✔ Fecha de creación
    • ✔ Url original
  • 📌 Redireccion: Una vez ingresado en tu link acortado, se te redirigirá a tu destino y se actualizarán los datos
  • 📌 Límites: No abuses del servidor, hay un límite de usos suficiente por hora (si lo sobrepasas se te bloquea el acceso)

🚀 Iniciando el proyecto

Necesitarás:

  1. Clona el repositorio
# Usando la url
git clone https://github.com/JavierPineyro/shurly.git
# Entra en la carpeta del proyecto
cd <NombreDelProyecto>
  1. Instala las dependencias con el administrador de paquetes que quieras
# usando npm:
npm install

# usando pnpm:
pnpm install

# usando yarn:
yarn install
  1. Agrega un archivo .env en la raíz del proyecto y crea las siguientes variables de entorno con tus credenciales de MongoDb Atlas:
  • PORT: El puerto donde se va a ejecutar el proyecto en desarrollo
  • BASE: La url base de tu página, en desarrollo es localhost:<PORT>
  • DB_PASS: Contraseña de tu base de datos de MongoDb
  • DB_USERNAME: Nombre de usuario de tu base de datos de MongoDb
  1. Ve a client/package.json y edita la propiedad proxy con la url base de tu proyecto (En desarrollo cambialo a localhost y el puerto que elegiste)
{
  "proxy": "example.com"
},

🤖 Comandos

Todos los comandos son ejecutados de la raíz del proyecto, desde la terminal

Command Action
npm install Instala las dependencias
npm start Levanta el proyecto para producción
npm run dev:server Inicia el servidor(desarrollo) localhost:3333
npm run build:ui Crea la build del cliente en /client/dist/