Nucleus - REST API para "Jw Cartelera Digital"

API REST desarrollada en nodejs para la aplicación cartelera digital, permite administrar distintas funciones administrativas inherentes a la cartelera y actividades programadas.

Documentación

Una vez clonado el repositorio, duplicar el archivo .env.sample y renombrar a .env, editar los parámetros de entorno a conveniencia, instalar los paquetes necesarios utilizando npm y ejecutar el servidor.

npm install

npm run dev

A continuación se describen las posibles peticiones disponibles en la API.

GET: /

Información sobre la estatus de la api.

GET: /api/users/

GET: /api/users/?page=<Int>&limit=<Int>

Ruta protegida, lista todos los usuarios, se requiere cómo mínimo rol de administrador, opcionalmente puede recibir los siguientes argumentos como parametros de query: ?page=Number&limit=Number para la paginación, retorna arreglo de objetos { data, totalPages, currentPage }.

GET: /api/users/profile/:id

Ruta protegida, obtiene un usuario según su id, retorna objeto con { _id, name, lastName, email, nickname, address, phone2, isGroupSupervisor, isGroupAssistant, isAux, isPr, monthlyReport, role, status, phone1, group, createdAt, updatedAt } se requiere cómo mínimo rol de administrador.

PATCH: /api/users/profile/:id

{
    "name": <String>,
    "lastName": <String>,
    "email": <String>,
    "password": <String>,
    "role": <Enumerator>,
    "status": <Boolean>
}

Ruta protegida, obtiene un usuario según su id, recibe objeto con { name, lastName, email, password, role, status }, retorna objeto con { _id, name, lastName, email, role, status token } se requiere cómo mínimo rol de administrador.

POST: /api/users/login

{
    "email": <String>,
    "password": <String>
}

Ruta pública, recibe objeto con { email y clave } de usuario registrado, devuelve token e información del usuario.

POST: /api/users/register

{
    "name": <String>,
    "lastName": <String>,
    "email": <String>,
    "password": <String>
}

Ruta pública, recibe objeto con { name, lastName, email, password } retorna objeto con { id, name, email, role } del usuario creado.

GET: /api/publishers/
POST: /api/publishers/new
GET: /api/publishers/:id
PATCH: /api/publishers/:id

GET: /api/monthlyreports
POST: /api/monthlyreports/new
GET: /api/monthlyreports/:id
PATCH: /api/monthlyreports/:id

Rutas protegidas creadas, por programar.

Prerrequisitos

Para ejecutar el proyecto localmente se requiere la instalación previa de Nodejs en su version 14.15.3 en adelante, descargable desde el sitio oficial del desarrollador:

Nodejs v14.15.3

Herramientas utilizadas

• Visual Studio Code - Editor de código.
• Nodejs - Entorno de desarrollo.
• MongoDB Atlas - Motor de Base de Datos.

Versiones

Se utiliza SemVer en el versionado. Para encontrar las versiones disponibles, mira tags en este repositorio.

Autores (origen de idea)

• Jorge Fernández - Software Developer - fsjorgeluis
• Javier Mora - Frontend / UI Developer - j4viermora

Licencia

GNU GPL v3.