README.md

sosvecinos.org

Recopilando mensajes de ayuda y socorro en un mapa para ayudarnos unos a otros.

http://sosvecinos.org

Tabla de Contenidos

• Cómo contribuir
• Instalación local
• Instalación local con Docker
  • Requisitos
  • Comandos
• Capturas de pantalla
  • Iconos utilizados

Cómo contribuir

• Puedes aportar feedback dirigiéndote a @pepellou en Twitter
• Explora la lista de issues y deja comentarios en ellas, o haz PRs que las resuelvan

Instalación local

0. Clona este repositorio (deberías saber cómo 😬)

1. Crea los archivos de configuración backend/config.php, backend/firebase-credentials.json, src/config.js y admin/config.js copiando de los archivos .ini correspondientes:

    cd backend
    cp config.php.ini config.php
    cp firebase-credentials.json.ini firebase-credentials.json
    cd ../src
    cp config.js.ini config.js
    cd ../admin
    cp config.js.ini config.js

2. Edita dichos archivos de configuración reemplazando todos los FILL_ME por los valores adecuados.

(pídeme los datos por DM en Twitter)

3. Actualiza las dependencias:

    cd backend
    composer install

4. Comprueba que puedes consultar los últimos tweets:

    php backend/run.php last

5. Comprueba que puedes recolectar tweets:

    php backend/run.php collect

6. Comprueba que puedes ver la web en local:

    open index.html

(open es un comando de Mac, pero simplemente puedes abrir index.html en tu navegador favorito)

Instalación local con Docker

Requisitos

• docker 19+
• docker-compose 1.25+
• Configurar backend/config.php, backend/firebase-credentials.json, src/config.js y admin/config.js como se especifica en la sección anterior

Comandos

• Construir/descargar las imágenes necesarias:

  docker-compose pull
  docker-compose build
  

• Arrancar la web (sólo html):

  docker-compose up app
  

  La web está accesible en: http://localhost:3000

• Ejecutar comandos del backend:

  docker-compose run --rm backend <COMANDO>
  

  Ejemplo:

  docker-compose run --rm backend db
  docker-compose run --rm backend last
  docker-compose run --rm backend collect
  

• Limpiar containers, volúmenes e imágenes:

  docker-compose down --rmi local --volumes
  

Capturas de pantalla

Iconos utilizados

SOS Emergency by Hali Gali Harun from the Noun Project

give love by Justin Blake from the Noun Project