Villanueva-Flavio / TP_IDS_Pokebuild-Maker

TP grupal de Introducción al desarrollo de software

Aplicacion: Pokebuild maker

Estado: Finalizado

Estado: Aprobado, pero a que costo?

Descripcion:

Pokebuild maker es un sitio web hecho para aquellos fanáticos de Pokemon que quieran calcular o mostrar sus equipos de los juegos de pokemon. El mismo te permitirá hacer pública el equipo creado y tus pokemons en posesión. En el caso de los pokemons, especificando: Qué pokemon es, Nombre opcional, nivel, y hasta 4 habilidades como los juegos suelen permitir. En el caso de los equipos (builds), se especifica: Los (hasta) 6 pokemons que conforman el equipo

Forma de uso:

Al ingresar al home se visualizarán todas las builds creadas por todos los usuarios con sus respectivos pokemons a la vista

En el cual si queremos aportar nuestra build tenemos que primero estar registrados, para poder bajo nuestro nombre, publicar nuestros pokemons y builds, por lo que en el boton de agregar (Con forma de pokebola en Home), elegiremos Agregar pokemon

Una vez que hayamos agregado todos los pokemons con la amplia posibilidad de todos los 1025 pokemons hasta la fecha de este README, y todas sus habilidades, procederemos a crear nuestra build

Una vez publicados, vamos a poder realizar nuestras propias modificaciones o eliminaciones de nuestras propias publicaciones ya sea modificar builds o pokemons, o así mismo eliminarlas. Podremos tambien visualizar una estadística general de todos los usuarios con la cantidad de pokemons y builds publicadas

Instalación:

1. Primero debés clonar este repositorio con git clone https://github.com/Villanueva-Flavio/TP_IDS_Pokebuild-Maker.git

2. Y debemos tener instalados Docker y Docker-compose Para instalarlo desde linux basta con simplemente: sudo apt update && sudo apt-get install docker docker-compose

2. b Para Windows Instalar WSL desde Microsoft Store Instalar Docker Desktop desde la página web oficial

3. Para levantar la aplicación debemos considerar que se levantarán 2 contenedores Database: En el puerto 4000 API/Frontend: En el puerto 5000 Por el cual para acceder a nuestra pagina web se realizará mediante localhost:5000/

4. Para levantar los contenedores: Situado en la carpeta raíz del repositorio (sudo en caso de linux) docker-compose up Para cerrarlo bastaría con CTRL + C desde el programa o docker-compose down

Pautas de desarrollo:

Links:

Ver backlog

Ver diseños preliminares

Paleta de colores:

Lightmode	Darkmode
#32a852	#4287f5
#fcba03	#eb4034
#1e2336	#5e00ff
#ffeeb2	#2f006f
#f4f4f4	#000000
#000000	#ffffff

Convenciones de commits:

[ADD] Commit de adiciones al proyecto
[DEL] Commit donde se remueven cosas
[FIX] Commit de bugfixes
[MER] Commit de merge
[#10] ID del backlog (Obligatorio)
Uso de Snake_Case obligatorio

APIs GET endpoints útiles:

1. /api

   Este endpoint es el home que nos derivará al resto de endpoints

2. /api/pokemons

   Este endpoint devolverá todos los pokemons de nuestra base de datos Especificando sus habilidades, id de la pokedex, nombre, nivel y owner

3. /api/builds

   Este endpoint devolverá todas las builds publicadas por todos los autores Con nombre, owner id y los (hasta) 6 pokemons, incluido su timestamp de creación

4. /api/users_profiles

   Este endpoint devoverá el nombre, foto, cantidad de pokemons y builds ingresadas de cada usuario

5. /api/get_all_pokemons

   Este endpoint fetchea el nombre e id de todos los pokemons existentes en la serie

6. /api/get_moves/id

   Te permitirá obtener los movimientos válidos del pokemon indicado, donde id está relacionado a la pokedex

7. /api/pokemons_by_user/id

   Este endpoint te permitirá obtener todos los pokemons que posee el usuario, con el patron de datos de /api/pokemons donde id es el id del usuario

8. /api/builds_by_user/id

   Este endpoint te permitirá obtener un listado de todas las builds que el usuario especificado posee, con el patrón de datos de /api/builds donde id es el id del usuario

9. /api/pokemon/id

   Este endpoint te devolverá un pokemon específico cargado en la base de datos donde id está relacionado a la tabla, con el patrón de datos de /api/pokemons pero siendo un solo pokemon

10. /api/build/id

    Este endpoint te devolverá una build específica cargada en la base de datos donde id está relacionado a la tabla, con el patrón de datos de /api/builds pero siendo una sola build