Files
shoppy/README.md
T
2024-11-21 11:43:38 +01:00

103 lines
3.6 KiB
Markdown

# Shop
[![codecov](https://codecov.io/gh/pablo-moreno/shoppy/graph/badge.svg?token=8oQg2Mqn3m)](https://codecov.io/gh/pablo-moreno/shoppy)
## Desarrollo
### Establecer variables de entorno
A partir del archivo `.env.example`, creamos un archivo `.env` en el que podemos establecer las
[variables de entorno](#variables-de-entorno).
### Instalar dependencias
```bash
pip install -r requirements.test.txt
```
### Lanzar migraciones
```bash
python manage.py migrate
```
### Arrancar servidor
```bash
python manage.py runserver
```
### Tailwind
```bash
python manage.py tailwind start
```
### Tareas de Celery
```bash
celery -A config worker -B -l debug
```
### Pruebas con pytest
```bash
pytest --cov
```
## Docker
### Descarga
```bash
docker pull ghcr.io/pablo-moreno/shoppy
```
### Construir imagen
```bash
docker build -t shoppy .
```
### Crear contenedor
**API**
```bash
docker run -it --rm -p 8000:80 -e RUN_SERVER=TRUE --env-file=.env shoppy_api
```
**Tareas en segundo plano**
```bash
docker run -it --rm -p 8000:80 -e RUN_CELERY=TRUE --env-file=.env shoppy_tasks
```
## Variables de entorno
Puedes crear un archivo `.env` con las siguientes variables de entorno.
| Variable | Default value | Comments |
|-------------------------|----------------------------------|--------------------------------------------|
| SECRET_KEY | secret key | Clave de encriptación |
| DEBUG | TRUE | Modo de desarrollo activo |
| DATABASE_URL | sqlite:///db.sqlite3 | URL de conexión a base de datos |
| STATIC_ROOT | static | Carpeta de estáticos |
| MEDIA_ROOT | media | Carpeta de archivos media |
| REDIS_HOST | redis | Dirección de servidor Redis |
| REDIS_PORT | 6379 | Puerto de Redis |
| PAGE_SIZE | 20 | Tamaño de paginación |
| ALLOWED_HOSTS | * | Hosts permitidos (CORS) |
| CELERY_BROKER_URL | redis://172.17.0.1:6379/0 | Url de conexión para celery |
| S3_ENABLED | FALSE | Activado protocolo S3 |
| S3_HOST | | URL de servidor S3 |
| AWS_ACCESS_KEY_ID | | Clave de acceso de S3 |
| AWS_SECRET_ACCESS_KEY | | Clave secreta de S3 |
| AWS_STORAGE_BUCKET_NAME | | Nombre del bucket de S3 |
| AWS_S3_ENDPOINT_URL | | Endpoint de S3 |
| REDSYS_SHARED_SECRET | sq7HjrUOBfKmC576ILgskD5srU870gJ7 | Clave privada de Redsys |
| REDSYS_MERCHANT_CODE | 999008881 | Código de negocio de Redsys |
| REDSYS_TERMINAL | 001 | Terminal de Redsys |
| REDSYS_CURRENCY_CODE | 978 | Código de moneda de Redsys |
| REDSYS_TPV_DOMAIN | | Dominio del TPV para redirección de Redsys |