Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 1.91 KB

README.md

File metadata and controls

54 lines (38 loc) · 1.91 KB
Raw

cb-base-backend

Repositorio base de backend para ConsiliumBots, con un par de modelos de ejemplo y capacidad de login.

Prerequisitos

Pasos a seguir

1. Cambios en proyecto

Es necesario hacer unos cambios al proyecto para poder utilizarlo. Cosas a necesarias a cambiar:

  • Cambiar cada instancia de al nombre del projecto. Por ejemplo, -> project.
  • Eliminar la carpeta .git y crear nuevo proyecto con git init. Setear upstream a cb-<project>-back.
  • Agregar el archivo secrets.json con las siguientes llaves: DB_HOST, DB_NAME, DB_PASSWORD, DB_PORT, DB_USERNAME, EMAIL_HOST, EMAIL_HOST_PASSWORD, EMAIL_HOST_USER, EMAIL_PORT.

2. Instalación librerías

Es necesario instalar librerías de requirements.txt. Se puede hacer con pip install -r requirements.txt.

3. Pasos admin

Es necesario que un administrador haga un par de pasos:

  • Generación de ECR en AWS
  • Generación de bases de datos
  • Generación de dos secretos en AWS, <project>/staging y <project>/production.
  • Aplicación de deployments

Uso

Una vez que está todo lo anterior listo, hay que conectar con la base de datos. Luego, correr:

  • python manage.py makemigrations
  • python manage.py migrate
  • python manage.py runserver

Organización

  • models: Modelos de datos.
  • serializers: Serializadores de datos.
  • viewsets: vistas (por modelo) de datos.
  • views: vistas (otras).
  • tests: tests.
  • factories: creadores de objetos.
  • migration

Testing

para correr tests, correr python manage.py test Para correr solo uno, correr python manage.py test app.testname

Documentación

Una vez que el servidor está corriendo, uno puede encontrar la documentación en: http://127.0.0.1:8000/documentation/