Keywords App

An application to generate your own questions from your texts.

Tecnologías utilizadas: 🕵️

Guia de inicio rápido para desarrolladores 🤔

Para ejecutar el proyecto primero complila y ejecuta la restapi:

cd restapi
pip install -r requirements.txt
uvicorn.exe main:app --reload

a continuación la webapp:

cd webapp
npm install
npm start

Deberias ser capaz de acceder a la webapp en http://localhost:3000 y la restapi http://localhost:8000

Configuración de variables de entorno ⚙️

La aplicación además utiliza numerosas variables de entorno que hay configurar.

Añadir un fichero denominado ".env" en el directorio "/restapi" con el contenido:

DATABASE="sqlite+aiosqlite:///development.db"
SECRET="SECRET_KEY"
SECONDS=7200

Añadir otro igual denominado ".env" al directorio "/webapp" con el contenido:

REACT_APP_API_URL=http://localhost:8000
REACT_APP_WEBAPP_URL=http://localhost:3000
REACT_APP_REDOC=http://localhost:8000/redoc
REACT_APP_SWAGGER=http://localhost:8000/docs

Configuración de base de datos en desarrollo 📦

En la fase de desarrollo se ha usado como SGBD SQLite para ello es necesario crear un fichero denominado "development.db" en el directorio restapi (la conexión se indica en el fichero .env anterior).

Una vez se arranca la restapi, las configuración de la base de datos se carga automáticamente, estas tablas se pueden visualizar con diferentes programas de manejo de sistemas de bases de datos para sqlite como DB Browser for sqlite o extensiones de visual studio.