Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 1.73 KB

README.md

File metadata and controls

83 lines (59 loc) · 1.73 KB

Backend Para Manejo de Tareas

Esta es una api construida en nodejs y express que proporciona las funciones para el manejo de las tareas ya sea crearlas, eliminarlas e incluso filtrarlas, cuenta con 2 endpoints uno para registrarte y otro para realizar el inicio de sesion y obtener un token de acceso

Tabla de contenidos

  1. Requisitos
  2. Instalación
  3. Uso
  4. Rutas
  5. Contribuciones
  6. Contacto

Requisitos

  • Node.js (v18 o superior)
  • npm (normalmente se instala con Node.js)

Instalación

git clone https://github.com/GuarU345/todo-list-api-express.git
cd nombre-del-proyecto
npm install
npm run dev

Uso

Esta API te permite acceder a las funciones para registrar usuarios y poder iniciar sesion tambien permite crear y eliminar las tareas por usuario

Ejemplo de solicitud GET a la ruta /api/todos

curl http://localhost:3000/api/ejemplo

Rutas

Obtener todas las tareas

  • Ruta: GET api/todos
  • Descripcion: Obtiene la lista de tareas de un usuario en especifico
  • Parametros de consulta: Ninguno.
  • Ejemplo de respuesta:
[
  {
    "title": "tarea1",
    "completed": false,
    "user":{
      "username":"test1"
    }
  }
]

Contribuciones

  • Crea un fork del repositorio
  • Crea una nueva rama para tus cambios: git checkout -b nueva-caracteristica
  • Realiza tus cambios y haz commit: git commit -m "añade nueva caracteristica
  • Envia tus cambios: git push origin tu-rama

Contacto

Si tienes alguna pregunta o sugerencia, no dudes en ponerte en contacto conmigo en [[email protected]] o con mi perfil de github GuarU345.

¡Gracias por utilizar la API!