README.es.md

Ciudad Accesible

Directorio web con información al día sobre lugares accesibles en la ciudad de Caracas, Venezuela. Este proyecto usa Create React App.

Índice

• Estado de la aplicación
• Stack
• Requerimientos
• Uso
• Contribuyendo al proyecto

Estado de la aplicación

La aplicación se encuentra en desarrollo. Planeamos desplegarla sobre un entorno de producción en un lapso de 3 meses a partir de hoy. ¡Estén atentos!

Stack

Además de create-react-app, la aplicación trabaja con el siguiente stack tecnológico:

• Node.js + Express
• PostgreSQL + Bookshelf.js

Requerimientos

Si deseas probar esta aplicación localmente, necesitarás instalar primero lo siguiente:

• Node.js (8.9.4 o superior)
• Yarn (1.5.1 o superior) / NPM (5.6.0 o superior)
• PostgreSQL (9.6.5 o superior)

Si deseas usar Docker, necesitarás:

• Docker (18.02.0-ce o superior)
• Docker Compose (1.19.0 o superior)

Por ahora, el archivo docker-compose.yml no está disponible para desarrollo asistido con Docker. Si deseas ayudarnos con ello, por favor envíanos un Pull Request 😄

Uso

La aplicación aún se encuentra en desarrollo, por lo que no cuenta con ninguna funcionalidad. Actualizaremos esta sección conforme avance el desarrollo.

Contribuyendo al proyecto

• Clona este repositorio
• cd ciudad_accesible
• yarn install o npm install
• git checkout -b your-feature
• git add . && git commit -m "Your feature"
• git push
• Envíanos tu PR

También puedes colaborar de la siguiente manera:

• Corrigiendo fallas
• Mejorando la documentación
• Corrigiendo errores ortográficos
• Incrementando la cobertura de código
• Refactorizando funcionalidades y/o pruebas
• Enviandonos problemas que encuentres con la aplicación (Puedes hacerlo haciendo click acá)