slococo-uni
/
bsition
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Bottler Sition
12 Commits 1 Branch 0 Tags 322 KiB
TypeScript 39.2%
Python 37.6%
JavaScript 17.3%
CSS 4.5%
Shell 1.4%
Go to file
Santiago Lo Coco 6301209762 Update README.md 
Co-authored-by: Ezequiel Bellver <ebellver@itba.edu.ar>
Co-authored-by: Juan Barmasch <jbarmasch@itba.edu.ar>
 		2022-11-28 15:17:44 -03:00
api Update API and add more functions 2022-11-28 15:12:20 -03:00
backend Update API and add more functions 2022-11-28 15:12:20 -03:00
.gitignore Update backend (and add elasticsearch) 2022-11-15 23:21:57 -03:00
.pre-commit-config.yaml Add run.sh and pre-commit 2022-11-15 23:29:06 -03:00
LICENSE.md Add LICENSE and README 2022-10-25 15:17:02 -03:00
README.md Update README.md 2022-11-28 15:17:44 -03:00
docker-compose.yml Update backend (and add elasticsearch) 2022-11-15 23:21:57 -03:00
poetry.lock Update API and add more functions 2022-11-28 15:12:20 -03:00
pyproject.toml Update API and add more functions 2022-11-28 15:12:20 -03:00
run.sh Update README.md and run.sh 2022-11-15 23:39:11 -03:00

README.md

BSition

Funciones a implementar

  • Creación de documentos
  • Edición de documentos
  • Anidación de documentos
  • Creación de tablas (estilo base de datos)
  • Edición de tablas
  • Filtrado y ordenado de tablas

Requerimientos

Debe instalar:

  • Docker
  • Python
  • Poetry

Instalación

Debe correr:

sh run.sh -i

Ejecución

Primero y principal, debe agregar un archivo .env en la raíz del proyecto que debe contener las siguientes variables:

SECRET=J4s1S2rl83pWTK1BcM5VL/rjjT51HLcADWqn4aoq2iS5qbg3wAtO4NlZ98=
MONGO_URL=mongodb://root:password@localhost:27017
ELASTIC_URL=http://localhost:9200
ELASTIC_PASSWORD=password
POSTGRES_HOST=localhost
POSTGRES_DB=bd2
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ían cambiar las contraseñas.

Debe dejar los URLs de las bases de datos como se indicaron pues así se las configuró con docker.

Luego, para levantar las bases de datos debe correr:

sh run.sh -d

Por último, para correr la API, debe hacerlo mediante:

sh run.sh -a

Documentación de la API

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 testing. Usted debería hacer los cambios necesarios si es que requiere correr BSition en producción.

Autores

  • Barmasch, Juan Martín (61033)
  • Bellver, Ezequiel (61268)
  • Lo Coco, Santiago (61301)