diff --git a/README.md b/README.md index 8a716bb..e71f72a 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,23 @@ [![build status](https://github.com/josseed/backend-test-zuniga/workflows/Django-CI/badge.svg)](https://github.com/josseed/backend-test-zuniga/actions) [![build status](https://github.com/josseed/backend-test-zuniga/workflows/Angular-CI/badge.svg)](https://github.com/josseed/backend-test-zuniga/actions) -Esta aplicación permite preguntarle a los usuarios de un workspace de slack que tipo de comida desean. -Visualizar los pedidos de los usuarios. +backend: ![Alt text](./backend/coverage.svg) + +Esta aplicación permite preguntarle a los usuarios de un workspace de slack que tipo de comida desean y visualizar sus pedidos. + +Todo esto gracias a un bot que permite la interacción con tu workspace! Desarrollado con Django como backend y Angular en el frontend. Enjoy :) ## Configuración del ambiente ## Es necesario tener instalado npm, python, pip, ngrok, docker y docker-compose para seguir estos pasos. -Las herramientas descritas son faciles de encontrar en la web, por lo que si no las tienes, las puedes instalar siguiendo los tutoriales de las paginas oficiales. + +Las herramientas descritas son fáciles de encontrar en la web, por lo que si no las tienes, las puedes instalar siguiendo los tutoriales de las paginas oficiales. + Este codigo esta testeado para python 3.6, 3.7 y 3.8 por lo cual se recomienda trabajar con estás versiones. + Para levantar las bases de datos necesarias utilizaremos el archivo docker-compose.yml. -el cual contiene una base de datos Redis, Postgres y PGadmin para poder ver nuestra DB Postgres. +El cual contiene una base de datos Redis, Postgres y PGadmin como visualizador de postres, tambíen posee las credenciales de estas tecnologías. ``` docker-compose up -d ``` @@ -33,16 +39,18 @@ npm i ## Configuraciones backend ## -Si usaras distintas bases de datos, configura el archivo: +Si vas a usar bds distintas, configura el archivo: app/settings/develop.py ``` python backend/manage.py makemigrations python backend/manage.py migrate +python backend/manage.py createsuperuser ``` ## Configuración bot slack ## -Primero deves crear una app de slack en el siguiente link: [Crear slack app](https://api.slack.com/apps?new_app=1) +Primero debes crear una app de slack en el siguiente link: [Crear slack app](https://api.slack.com/apps?new_app=1) + Luego lo debes invitar a tu workspace de testing con con los siguientes permisos: * chat:write * im:history @@ -58,7 +66,7 @@ VERIFICATION_TOKEN = [your-verification-token] BOT_USER_ACCESS_TOKEN = [your-bot-user-access-token] ``` -Configura tu bot a tu gusto con las siguientes configuraciones: +Configura el bot a tu gusto con las siguientes configuraciones: ``` AVAILABLE_START_HOUR = 8 @@ -74,6 +82,7 @@ python manage.py test ``` ## Para levantar el backend ## +necesitamos dos terminales para esto. ``` cd backend python manage.py runserver # en una terminal @@ -97,9 +106,11 @@ cd 'path-ngrok' ## configurar el webhook del bot para que puedas recibir los mensajes de slack ## Este es el ultimo paso, dado que el webhook de slack solo funciona con https(para eso ngrok). + Dirigete a https://api.slack.com/apps/'tu-app-id'/event-subscriptions? Activa los eventos y agrega la url correspondiente. + EJ: https://883379003fb5.ngrok.io/actions/event/hook/ Reemplazar los numeros que te entrega ngrok. diff --git a/backend/coverage.svg b/backend/coverage.svg new file mode 100644 index 0000000..b3e8ba0 --- /dev/null +++ b/backend/coverage.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + coverage + coverage + 88% + 88% + + diff --git a/backend/meal_manager/views.py b/backend/meal_manager/views.py deleted file mode 100644 index 91ea44a..0000000 --- a/backend/meal_manager/views.py +++ /dev/null @@ -1,3 +0,0 @@ -from django.shortcuts import render - -# Create your views here.