puniker / api_notas Goto Github PK

Bienvenido a mi proyecto de API de Notas. La parte de la app se ha desarrollado con React y Vite

Instalamos todas las dependencias y el script de postinstalación.

$ npm install

Este script crea enlaces simbólicos de los módulos de la app en la carpeta node_modules para poder importarlos sin rutas relativas en el proyecto. Si el comando anterior no ha ejecutado el script de postinstalación, hay que ajecutarlo manualmente.

$ npm install postinstall

$ npm run dev

La aplicación corre sobre el puerto 3001, para cerrar este puerto una vez cerrada la app:

$ npm run killport

$ npm start

$ npm run app_dev

Las variables de entorno se guardan en el fichero .env en la raiz del repositorio. Las variables que se usan son las siguientes:

• PORT: Puerto en el que se ejecuta la app.
• KEY_FILE: Ruta del fichero con las claves de usuario de la API.
• DATA_FILE: Ruta del fichero con las notas.
• CSV_SEPARATOR: Separador de datos en los ficheros CSV. (Esta variable de entorno se eliminará en futuras versiones)

Para obtener un listado de todas las notas se puede pasar el valor undefined en el ID de la nota

const notas = require( './modules/notas' )

notas.getNota( id_de_la_nota, function( notas ) {
    // code ... 
} )

Para publicar una nota hay que pasar a la función postNota los siguientes parámetros mediante el método GET:

• título
• descripcion
• estado
• user

Tanto la fecha como el id de la nota los asignará la API automaticamente

const notas = require( '../modules/notas' )

notas.postNota( datos_de_la_nota, function( notas ) {
    // code ...
} )

Para eliminar una nota hay pasar mediante el método GET el id de la nota a la función deleteNota().

const notas = require( '../modules/notas' )

notas.deleteNota( id_de_la_nota, function( notas ) {
    // code ...
} )

• Funcionalidad de API Keys para los usuarios
• Eliminar varias notas a la vez