fullstack fastapi vuejs price aggregator
1.0.0
Agregador de precios de supermercados del Reino Unido mediante web scraping. Esto fue desarrollado para mi proyecto universitario como MVP por lo que hay aspectos que no funcionan correctamente. Puede que lo actualice en el futuro.
Asegúrese de tener Docker y Node.js instalados.
docker-compose up --build -d
. Inicia el backend y, en la primera ejecución, creará todos los contenedores necesarios, lo que puede tardar unos minutos.docker-compose exec backend bash
.python manage.py createdb
desde el shell bash.python manage.py seeddb
Tenga en cuenta que todas las contraseñas están configuradas como contraseña.cd
en el directorio del cliente, ejecute npm install
, que instalará los módulos de nodo necesarios.npm run serve
que servirá a la interfaz del cliente. URL | Descripción |
---|---|
0.0.0.0:8000/api | API JSON de back-end |
0.0.0.0:8000/docs | Documentación de referencia de API generada por Backend OpenAPI/Swagger |
0.0.0.0:8000/redoc. | Documentación interactiva alternativa proporcionada por ReDoc |
servidor local: 9527 | Aplicación frontend VueJS de una sola página |
El backend incluye una CLI que está fuertemente inspirada en Dispatch de Netflix.
Se utilizó typer
(mismo autor que FastAPI) para crear una CLI para el proyecto y se accede a él a través de Manage.py.
Para ejecutar comandos, necesitará un shell que se ejecute dentro del contenedor backend con:
docker-compose run backend bash
Para ver todos los comandos disponibles:
root@72293bee6b37:/app# python manage.py
Usage: manage.py [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
config Display application configuration.
createdb Creates an empty database.
createrole Add role to database.
createuser Create new user in the database.
develop Start a development server with reload.
dropdb Drop the existing database.
routes Display application routes and dependencies.
seeddb Add fake data to database.
shell Starts an interactive shell with app object imported.
root@72293bee6b37:/app# python manage.py routes
Application Endpoints
Path Methods Dependencies
----------------------------- --------- --------------------------------------------------------
/api/v1/users/ GET ['RoleChecker: Roles: admin,user']
/api/v1/users/ POST ['RoleChecker: Roles: admin,user']
/api/v1/users/{id} GET ['RoleChecker: Roles: admin,user']
/api/v1/users/{id} PUT ['RoleChecker: Roles: admin,user']
/api/v1/users/{id} DELETE ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}/roles GET ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}/roles PUT ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}/shops GET ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}/shops PUT ['RoleChecker: Roles: admin,user']
/api/v1/roles/ GET ['RoleChecker: Roles: admin,user']
/api/v1/roles/ POST ['RoleChecker: Roles: admin,user']
/api/v1/roles/{id} GET ['RoleChecker: Roles: admin,user']
/api/v1/roles/{id} PUT ['RoleChecker: Roles: admin,user']
/api/v1/roles/{id} DELETE ['RoleChecker: Roles: admin,user']
/api/v1/shops/ GET ['RoleChecker: Roles: admin,user']
/api/v1/shops/ POST ['RoleChecker: Roles: admin,user']
/api/v1/shops/{id} PUT ['RoleChecker: Roles: admin,user']
/api/v1/shops/{id} DELETE ['RoleChecker: Roles: admin,user']
/api/v1/shops/listings/ GET ['RoleChecker: Roles: admin,user']
/api/healthcheck GET []
python manage.py config
Application Configuration
Setting Value(s)
-------------------------- --------------------------------------------------------------------
APP_DIR /app/app
STATIC_DIR /app/app/static
EMAIL_TEMPLATES_DIR /app/app/static/email-templates/html
PROJECT_NAME Fastapi Backend
SERVER_HOST 0.0.0.0
CORS_WHITELIST ['http://localhost', 'http://localhost:8000', 'http://0.0.0.0:8000']
FASTAPI_ENV development
DEBUG False
LOG_LEVEL debug
FIRST_SUPERUSER [email protected]
FIRST_SUPERUSER_PASSWORD a5dbf43e07f4d19e5b73bc89a8f74
USERS_OPEN_REGISTRATION True
SECRET_KEY **********
JWT_AUTH_LIFETIME_SECONDS 604800
JWT_EMAIL_LIFETIME_SECONDS 3600
SMTP_USER [email protected]
SMTP_PASSWORD **********
SMTP_TLS False
SMTP_SSL False
SMTP_HOST mailhog
SMTP_PORT 1025
POSTGRES_USER postgres
POSTGRES_PASSWORD **********
POSTGRES_HOST postgres
POSTGRES_PORT 5432
POSTGRES_DB fastapi_backend