Ciudad Accesible

Web directory to provide up-to-date information for accessible sites in the city of Caracas, Venezuela. This project was bootstrapped with Create React App.

Puedes leer la versión en español de este documento haciendo click acá

Table of contents

• State of the application
• Stack
• Requirements
• Usage
• Contributing

State of the application

The application is under development. We plan to deploy it to production in a timelapse of at least 3 months from now on. Stay tuned!

Stack

Besides create-react-app, the application works with the following stack:

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

Requirements

If you wish to test this application locally, you'll need to install the following beforehand:

• Node.js (8.9.4 or higher)
• Yarn (1.5.1 or higher) / NPM (5.6.0 or higher)
• PostgreSQL (9.6.5 or higher)

If you wish to use Docker, you'll need:

• Docker (18.02.0-ce or higher)
• Docker Compose (1.19.0 or higher)

For now, a docker-compose.yml file is not available for Docker-assisted development. If you wish to help us with it, feel free to submit a Pull Request 😄

Usage

The application is still a work in progress, so it doesn't have any features yet. We will update this accordingly.

Contributing

• Clone this repo
• cd ciudad_accesible
• yarn install or npm install
• git checkout -b your-feature
• git add . && git commit -m "Your feature"
• git push
• Send in your PR

You can also help us with any of the following:

• Fixing bugs
• Fixing typos
• Improving the docs
• Increasing code coverage
• Refactoring features and/or tests
• Submitting issues (You can do so here)