📦 pack-hood 📦

pack-hood es una simple aplicacion del lado del servidor diseñada para la academia de Coderhood.

El fin de esta aplicacion es darle a los estudiantes de la academia una herramienta para aprender a utilizar una API de forma sencilla.

• 📦 pack-hood 📦

  • Sobre pack-hood
    • Tipos de usuarios:
    • Paquetes:
  • Instalacion
  • Ficha tecnica

• Instalacion

• Documentacion de la API

• Ficha tecnica

---

Sobre pack-hood

pack-hood es una empresa de logistica ficticia que busca resolver el envio de productos de terceros a sus clientes.

Tipos de usuarios:

En pack-hood existen dos tipos de usuarios:

• Operadores:
  Los operadores son los encargados de gestionar los envios de productos, estos se ubican en los puntos de deposito de paquetes. Los operadores crean, modifician, eliminan y consultan los envios de productos. Ellos son la primera persona que interactua con el cliente que quiere utilizar los servicios de pack-hood.

• Operadores Administradores:
  Los Operadores Administradores son los encargados de gestionar los usuarios de la aplicacion, los Operadores Administradores pueden crear, modificar, eliminar y consultar los usuarios de la aplicacion.

Paquetes:

En pack-hood los paquetes tienen una serie de atributos.

• ID:
  El ID es un identificador unico para cada paquete, usualmente un numero.

• Estado:
  El estado del paquete puede ser:

  • En deposito:
    El paquete esta en el deposito de paquetes, es el primer estado y se setea al crear el paquete.
  • En viaje:
    El paquete esta en viaje a destino, es el segundo estado y se setea cuando el Operador le entrega el paquete al personal de logistica.
  • Entregado:
    El paquete esta entregado, es un estado final y se setea cuando el personal de logistica le entrega el paquete al cliente final.
  • Cancelado:
    El paquete esta cancelado, es un estado final y se setea cuando el Operador, o el Operador Administrador, el personal de logistica o el cliente final cancela el paquete. El proceso de cancelacion requiere que el paquete vuelva al deposito y sea retirado por el remitente.

• Tamaño:
  El tamaño del paquete puede ser:

  • Chico:
    El paquete es chico, es una medida adecuada para el personal de logisitica que utiliza bicis o motos.

  • Mediano:
    El paquete es de mediano tamaño, es una medida adecuada para el personal de logistica que utiliza motos (pudiendo llevar un solo paquete a la vez) o autos.

  • Grande:
    El paquete es considerable tamaño, es una medida adecuada para el personal de logistica que utiliza autos o camionetas.

• Contenido:
  El contenido del paquete es un texto breve que describe el contenido del paquete. (Ej. "Microchips", "Celular" etc.)

• Direccion de envio:
  El destino del paquete es texto indicando la direccion donde debe ser enviado el paquete.

• Nombre del destinatario:
  Nombre completo de quien recibe el paquete.

• Celular del destinatario:
  Celular del destinatario del paquete, incluyendo el codigo de area.

---

Instalacion

• Requerimientos
  • Node.js
  • GIT (opcional)
  • NPM o Yarn

Abrimos la terminal en donde querramos instalar el proyecto

1. Clonar el repositorio

    git clone
   

2. Acceder a la carpeta de pack-hood

   cd pack-hood
   

3. Instalar dependencias

    npm install
   

   o, en el caso de yarn

    yarn install
   

4. Configurar el puerto de la aplicacion

   Por defecto el puerto de la aplicacion es el 5000, pero podemos cambiarlo en el archivo config.js.

   const CONFIG = {
       PORT: '5000', // <-- Cambiar el puerto
       JWT_SECRET: 'coderhood2021',
   };
   
   module.exports = CONFIG;

5. Ejecutar la aplicacion

    npm dev
   

   o, en el caso de yarn

    yarn dev
   

---

Ficha tecnica

pack-hood esta desarrollado en Node.js, con el framework Express.js, con una base de datos en memoria.

La idea de pack-hood es que sea sencilla de instalar y utilizar, por eso no se involucra una base de datos real en la aplicacion.

Coderhood siempre fue, y va a ser gratis.

Agradeceriamos que colabores con la evolucion de pack-hood!