From 1fcfba86662076a1b1e51777c540f8cbb56a7fbe Mon Sep 17 00:00:00 2001 From: Pano Valdez Date: Mon, 21 Oct 2024 16:31:27 -0300 Subject: [PATCH] actualizo doc --- .env.example | 21 +++++++++++++++++++++ README.md | 7 ++++++- docker-compose.yml | 1 + 3 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..5649220 --- /dev/null +++ b/.env.example @@ -0,0 +1,21 @@ +MONGODB_URL=mongodb://localhost:27017 +MONGODB_NAME=bien-restituido +JWT_SECRET=mySecretPassword! +MONGODB_TEST_URI=mongodb://localhost:27017/bien-restituido-test + +ADMIN_MAIL=it@democracyos.org +ADMIN_USERNAME=adminuser +ADMIN_PASS=123123 + +S3_UPLOAD_KEY= +S3_UPLOAD_SECRET= +S3_UPLOAD_BUCKET= +S3_UPLOAD_REGION= + +MAILER_HOST= +MAILER_PORT= +MAILER_USER= +MAILER_PASSWORD= + +NEXT_PUBLIC_URL_APP=http://localhost:3000 +NEXT_PUBLIC_AUTH_TOKENS_KEY=RES_AUTH diff --git a/README.md b/README.md index 36556c6..a0a030c 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,11 @@ Bien Restituido es un proyecto desarrollado para el desmantelamiento patrimonial ## ⚒️ Guía de instalación y ejecución +> Configuración inicial: +> +> - Copiá el archivo `.env.example` en uno nuevo `.env.local` +> - Completá los valores de las variables + Hay 2 maneras de preparar el entorno para desarrollo. A través de Docker, o configurando el entorno de Node ### Docker @@ -54,7 +59,7 @@ $ npm run dev ## Estructura del Proyecto -```ruby +```bash bien-restituido/ │ ├── public/ # Archivos estáticos diff --git a/docker-compose.yml b/docker-compose.yml index c53ac57..3822085 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -15,6 +15,7 @@ services: volumes: - .:/usr/src/app - /usr/src/app/.next + - /usr/src/app/node_modules env_file: - .env.local links: