slococo-uni
/
bsition
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md 

Co-authored-by: Ezequiel Bellver <ebellver@itba.edu.ar>
Co-authored-by: Juan Barmasch <jbarmasch@itba.edu.ar>
This commit is contained in:
Santiago Lo Coco 2022-11-29 09:03:48 -03:00
parent 64171ff889
commit 1e1576679a
2 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -25,7 +25,8 @@ Puede verla en el siguiente [link](https://www.canva.com/design/DAFSnStE99g/k9QG
Debe instalar:
- Docker
- Python
- Docker-compose
- Python >= 3.10
- Poetry
## Instalación
@ -50,17 +51,17 @@ POSTGRES_USER=root
POSTGRES_PASSWORD=password
```
En un ambiente de testeo (como es el caso) puede simplemente copiar el archivo pero, si se corriese en producción, se debería cambiar dependiendo el caso de uso.
En un ambiente de testeo (como es el caso) puede simplemente copiar el archivo, pero, si se corriese en producción, se deberá cambiar dependiendo el caso de uso.
Debe dejar los URLs de las bases de datos como se indicaron pues así se las configuró con docker.
Debe dejar los URLs de las bases de datos como se indicaron pues así se las configuró con docker. Por lo tanto, deberá dejar libres los puertos 5432, 27017 y 9200.
Ahora, para levantar las bases de datos debe correr:
Ahora, para levantar las bases de datos (usando `docker-compose`) debe correr:
```
sh run.sh -d
```
Debe esperar al menos 30s (dependiendo de su computadora) para que levanten todas las bases de datos. Una forma de verificar que hayan levantado todas es que no siga habiendo nuevo output en la terminal que corrió el comando anterior.
Debe esperar al menos 30 segundos (dependiendo de su computadora) para que levanten todas las bases de datos. Una forma de verificar que hayan levantado es que no siga habiendo nuevo output en la terminal que corrió el comando anterior.
Luego, en otra terminal, debe configurar las bases de datos mediante el siguiente comando:
@ -68,7 +69,7 @@ Luego, en otra terminal, debe configurar las bases de datos mediante el siguient
sh run.sh -c
```
Por último, para correr la API, debe hacerlo mediante:
Por último, para correr la API + backend, debe hacerlo mediante:
```
sh run.sh -a
@ -78,7 +79,9 @@ sh run.sh -a
Puede ir a `http://localhost:8000/docs` para ver el `Swagger`. Notemos que se usó en todo momento `localhost` pues se supone un ambiente de testeo.
Además, cuenta con una colección de `Postman` en [docs/bsition_postman.json](docs/bsition_postman.json). Aquí se muestra, a grandes rasgos, el funcionamiento de la API.
Además, cuenta con una colección de `Postman` en [docs/bsition_postman.json](docs/bsition_postman.json). Consulte el siguiente [link](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/) para ver cómo se importa.
En esta colección se muestra, a grandes rasgos, el funcionamiento de la API.
## Autores
- Barmasch, Juan Martín (61033)

2
pyproject.toml
View File

@ -1,7 +1,7 @@
[tool.poetry]
name = "bsition"
version = "0.1.0"
description = "TP BD2"
description = "Simplificamos tus notas"
authors = [
"Juan Martin Barmasch <jbarmasch@itba.edu.ar>",
"Ezequiel Bellver <ebellver@itba.edu.ar>",