laimas/lista_tarea repository overview

⁠API Lista de tareas

Pequeña api para crear, listar, editar y eliminar tareas.

⁠Documentacion consultada

Libreria API REST

• Django Rest Framework⁠

Libreria para autenticacion por token

• Django Rest Auth⁠

Libreria para crear usuarios

• Django Allauth⁠

Docker para contenerizar la api

• Docker⁠

TODO-CHALLENGE-INVERA
|
│   .gitIgnore
│   LICENSE
│   README.md
│   README_challenge_Invera.md
│   requirements.txt
│
├───docker_lista_tareas
│   │   docker-compose.yaml
│   │   Dockerfile
│   |   requirements.txt
|   |
│   └───lista_tareas
│       │   db.sqlite3
│       │   manage.py
│       │   requirements.txt
│       │
│       ├───lista_tareas
│       │       asgi.py
│       │       settings.py
│       │       urls.py
│       │       wsgi.py
│       │       __init__.py
│       │
│       └───lista_tareas_api
│           │   admin.py
│           │   apps.py
│           │   models.py
│           │   serializer.py
│           │   tests.py
│           │   urls.py
│           │   views.py
│           │   __init__.py
│           │
│           ├───migrations
│           │       0001_initial.py
│           │       __init__.py
│           │
│           └───utils
│                   permisos_users.py
│                   __init__.py
│
└───lista_tareas
    │   db.sqlite3
    │   manage.py
    │   requirements.txt
    │
    ├───lista_tareas
    │       asgi.py
    │       settings.py
    │       urls.py
    │       wsgi.py
    │       __init__.py
    │
    └───lista_tareas_api
        │   admin.py
        │   apps.py
        │   models.py
        │   serializer.py
        │   tests.py
        │   urls.py
        │   views.py
        │   __init__.py
        │
        ├───migrations
        │       0001_initial.py
        │       __init__.py
        │
        └───utils
                permisos_users.py
                __init__.py

⁠pasos previos antes de su utilizacion

Clonar este repositorio

git clone https://github.com/Vosinepi/todo-challenge-invera

⁠Con Docker

instalar Docker y docker-compose

1. Si desea utilizar el conteiner de docker, dentro de la carpeta del docker_lista_tareas ejecutar el siguiente comando

docker-compose build

docker-compose up

Saldran varios mensajes en la consola, cuando termine de ejecutarse, se podra acceder a la api en el siguiente enlace http://127.0.0.1:8000/lista_tareas/⁠

De ser requerido se puede descarga la imagen de docker desde el siguiente enlace https://hub.docker.com/repository/docker/laimas/lista_tarea⁠

docker pull laimas/lista_tarea:latest

⁠Sin Docker con virtualenv

1. Ejecutar entorno virtual

source venv/bin/activate

1. Instalar dependencias

pip install -r requirements.txt

1. Ejecutar migraciones

python manage.py migrate

1. Crear super usuario

python manage.py createsuperuser

username: admin email: [email protected]⁠ password: admin

1. Ejecutar servidor

python manage.py runserver

⁠Para acceder a la api hay que ingresar las credenciales

solo se puede acceder a la api si se esta autenticado y cada usuario solo puede ver sus tareas y editarlas salvo que sea superusuario.

• login http://127.0.0.1:8000/lista_tareas/v1/authentication/login
• token http://127.0.0.1:8000/lista_tareas/v1/token/
• logout http://127.0.0.1:8000/lista_tareas/v1/authentication/logout
• user http://127.0.0.1:8000/lista_tareas/v1/authentication/user
• registro http://127.0.0.1:8000/lista_tareas/v1/registration/

⁠ENDPOINTS

Listado de tareas GET

http://127.0.0.1:8000/lista_tareas/v1/listado/

Crear tarea POST

http://127.0.0.1:8000/lista_tareas/v1/listado/

Ver tarea GET

http://127.0.0.1:8000/lista_tareas/v1/tarea/<pk>/

Editar tarea PUT

http://127.0.0.1:8000/lista_tareas/v1/tarea/<pk>/

Eliminar tarea DELETE

http://127.0.0.1:8000/lista_tareas/v1/tarea/<pk>/

Actualizar estado de tarea

http://127.0.0.1:8000/lista_tareas/v1/tarea/<pk>/

⁠Buscar tareas FILTER

http://127.0.0.1:8000/lista_tareas/v1/buscar/?search=

Posibles upgrades:

• agregar mas filtros
• agregar mas campos a la tarea
• agregar mas campos al usuario
• autenticacion con redes sociales
• JWT token para la autenticacion y mejora de seguridad
• implementar un frontend de ser necesario