|
| 1 | +# Todo App API |
| 2 | + |
| 3 | +## Variables de Entorno |
| 4 | + |
| 5 | +```ini |
| 6 | +NODE_ENV= |
| 7 | +PORT= |
| 8 | +DB_HOST= |
| 9 | +DB_USER= |
| 10 | +DB_PASSWORD= |
| 11 | +DB_PORT= |
| 12 | +DB_NAME= |
| 13 | +DB_VERSION= |
| 14 | +``` |
| 15 | + |
| 16 | +* **NODE_ENV** El entorno en el que nosencontramos |
| 17 | +* **PORT** El puerto donde va a correr la aplicación |
| 18 | +* **DB_HOST** El `host` donde se rncuentra corriendo la base de datos |
| 19 | +* **DB_USER** El usuario con el cual accedemos a esa base de datos |
| 20 | +* **DB_PASSWORD** El password asociado a ese usuario |
| 21 | +* **DB_PORT** El puerto en el cual escucha la base de datos |
| 22 | +* **DB_NAME** El nombre asociado a la base de datos |
| 23 | +* **DB_VERSION** La versión del motor de la base de datos |
| 24 | + |
| 25 | +## Arrancar la Base de Datos usando Docker |
| 26 | + |
| 27 | +Construimos primero la imagen del servidor de la base de datos |
| 28 | + |
| 29 | +```bash |
| 30 | +$ docker build -t lemoncode/postgres_todo_server -f Dockerfile.todos_db . |
| 31 | +``` |
| 32 | + |
| 33 | +Levantamos la base de datos construida anteriormente. |
| 34 | + |
| 35 | +```bash |
| 36 | +$ docker run -d -p 5432:5432 -v todos:/var/lib/postgresql/data --name postgres_todo_server lemoncode/postgres_todo_server |
| 37 | +``` |
| 38 | + |
| 39 | +> NOTA: Para que la base de datos este, el volumen al que estamos mapeando debe de estar vacío, si no la inicialización no ocurrirá. |
| 40 | +
|
| 41 | +Para comprobar que la base de datos se encuentra en ejecución debemos ejecutar |
| 42 | + |
| 43 | +```bash |
| 44 | +$ docker exec -it postgres_todo_server psql -U postgres |
| 45 | +``` |
| 46 | + |
| 47 | +Y dentro del listado de la bases de datos, deberíamos ver `todos_db`, para listar las bases de datos `\l`, y después `enter`. |
| 48 | + |
| 49 | +``` |
| 50 | +postgres=# \l |
| 51 | + List of databases |
| 52 | + Name | Owner | Encoding | Collate | Ctype | Access privileges |
| 53 | +-----------+----------+----------+------------+------------+----------------------- |
| 54 | + postgres | postgres | UTF8 | en_US.utf8 | en_US.utf8 | |
| 55 | + template0 | postgres | UTF8 | en_US.utf8 | en_US.utf8 | =c/postgres + |
| 56 | + | | | | | postgres=CTc/postgres |
| 57 | + template1 | postgres | UTF8 | en_US.utf8 | en_US.utf8 | =c/postgres + |
| 58 | + | | | | | postgres=CTc/postgres |
| 59 | + todos_db | postgres | UTF8 | en_US.utf8 | en_US.utf8 | |
| 60 | +(4 rows) |
| 61 | +``` |
| 62 | + |
| 63 | +Para conectar con la base de datos en nuestro entorno local, debemos tener creado un fichero `.env` en el raíz, que se vea de la siguiente manera: |
| 64 | + |
| 65 | +```ini |
| 66 | +DB_HOST=localhost |
| 67 | +DB_USER=postgres |
| 68 | +DB_PASSWORD=postgres |
| 69 | +DB_PORT=5432 |
| 70 | +DB_NAME=todos_db |
| 71 | +DB_VERSION=10.4 |
| 72 | +``` |
| 73 | + |
| 74 | +Para generar las distintas tablas dentro de nuestra base de datos ejecutaremos: |
| 75 | + |
| 76 | +```bash |
| 77 | +$ $(npm bin)/knex migrate:latest |
| 78 | +``` |
| 79 | + |
| 80 | +Para tener una semilla de datos, podemos lanzar |
| 81 | + |
| 82 | +```bash |
| 83 | +$ $(npm bin)/knex seed:run |
| 84 | +``` |
| 85 | + |
| 86 | +## Ejecutando Unit Tests |
| 87 | + |
| 88 | +Para ejecutar los unit tests, simplemente, tenemos que lanzar el siguiente comando |
| 89 | + |
| 90 | +```bash |
| 91 | +$ npm run test |
| 92 | +``` |
| 93 | + |
| 94 | +## Ejecutando Tests de Integración |
| 95 | + |
| 96 | +Para jecutar los test de integración necesitamos que la base de datos, corriendo y lista para recibir peticiones: |
| 97 | + |
| 98 | +```bash |
| 99 | +$ docker run -d -p 5432:5432 -v todos:/var/lib/postgresql/data --name postgres_todo_server lemoncode/postgres_todo_server |
| 100 | +``` |
| 101 | + |
| 102 | +Después de hacer esto simplemente tenemos que ejecutar: |
| 103 | + |
| 104 | +```bash |
| 105 | +$ npm run test:e2e |
| 106 | +``` |
| 107 | + |
| 108 | +## Ejecutando la aplicación con Docker en nuestro entorno local |
| 109 | + |
| 110 | +```bash |
| 111 | +$ docker build -t lemoncode/todo-app . |
| 112 | +``` |
| 113 | + |
| 114 | +```bash |
| 115 | +$ docker network create lemoncode |
| 116 | +``` |
| 117 | + |
| 118 | +```bash |
| 119 | +$ docker run -d -v todos:/var/lib/postgresql/data \ |
| 120 | + --network lemoncode \ |
| 121 | + --name pg-todo-server \ |
| 122 | + lemoncode/postgres_todo_server |
| 123 | +``` |
| 124 | + |
| 125 | +```bash |
| 126 | +$ docker run -d --rm -p 3000:3000 \ |
| 127 | + --network lemoncode \ |
| 128 | + -e NODE_ENV=production \ |
| 129 | + -e PORT=3000 \ |
| 130 | + -e DB_HOST=pg-todo-server \ |
| 131 | + -e DB_USER=postgres \ |
| 132 | + -e DB_PASSWORD=postgres \ |
| 133 | + -e DB_PORT=5432 \ |
| 134 | + -e DB_NAME=todos_db \ |
| 135 | + -e DB_VERSION=10.4 \ |
| 136 | + lemoncode/todo-app |
| 137 | +``` |
| 138 | + |
| 139 | +```bash |
| 140 | +$ curl localhost:3000/api/ |
| 141 | +[{"id":1,"title":"Learn GitHub Actions","completed":false,"order":null,"dueDate":null},{"id":2,"title":"Learn Groovy","completed":false,"order":null,"dueDate":null},{"id":3,"title":"Learn EKS","completed":false,"order":null,"dueDate":null}] |
| 142 | +``` |
| 143 | + |
| 144 | + |
| 145 | + |
0 commit comments