Estructura de directorios de Alaveteli

Esta página ofrece una vista general sobre dónde encontrar distintos datos en los directorios de Alaveteli.

Si solo está instalando Alaveteli, probablemente nunca necesite preocuparse de esto; es bastante más práctico cuando un desarrollador planea llevar a cabo cambios más significativos en el código. No necesita estar familiarizado con Ruby para realizar la instalación o aplicar modificaciones básicas en ella.

Alaveteli utiliza Ruby on Rails, una infraestructura web de tipo «modelo-vista-controlador» común; si está familiarizado con Rails, ya conocerá estos detalles. Para obtener más información sobre la estructura de Rails, consulte el sitio web de Ruby on Rails.

Directorios principales y funciones de cada uno de ellos

app

núcleo del código de aplicación de Alaveteli

assets

recursos estáticos que requieren una compilación previa para poder dar servicio

fonts

images

javascripts

stylesheets

hojas de estilo en formato CSS o SCSS

Las hojas de estilo SCSS se compilan como CSS.

controllers

helpers

mailers

models

views

cache

archivos temporales de descarga, datos adjuntos y plantillas

commonlib

librería de funciones comunes de mySociety

Mantenemos una librería común, que utilizamos en muchos de nuestros proyectos (no solo en Alaveteli). Está implementada como un submódulo de git para que Alaveteli la contenga aunque el código sea independiente. Normalmente no es necesario tener nada de esto en cuenta (ya que git lo gestiona automáticamente), pero si realmente necesita cambiar algo al respecto, tenga en cuenta que se trata de un repositorio independiente.

config

archivos de configuración

El archivo primario de configuración es general.yml. Este archivo no se halla en el repositorio de git (ya que contendrá información específica de su instalación, incluida la contraseña de la base de datos), pero hay archivos de ejemplo.

db

archivos de base de datos

migrate

Migración de Rails (actualización del esquema de la base de datos hacia arriba o abajo a medida que se desarrolla el código).

doc

documentación

Se trata de información técnica adicional añadida a la documentación principal (la que está leyendo actualmente), que se almacena en el repositorio de git, en la rama gh-pages y se publica como páginas de GitHub.

lib

librerías personalizadas

tasks

Tareas de Rake.

themes

Aquí vive su tema de Alaveteli.

locale

traducciones (internacionalización/i18n)

Las cadenas de texto de traducción se almacenan en archivos .po dentro de directorios específicos para la localización y codificación. Por ejemplo, es/ contiene las traducciones para el sitio en español.

log

archivos de registro de aplicación

public

archivos estáticos que pueden dar servicio directamente

script

shell scripts para el servidor

Por ejemplo, alert-overdue-requests ejecuta el script que encuentra solicitudes que han superado el límite de tiempo y las envía por correo electrónico.

spec

pruebas

El entorno de pruebas de Alaveteli funciona con rspec.

tmp

archivos temporales

vendor

software de terceros

bundle

paquete de gems necesario para ejecutar Alaveteli

Hemos omitido algunos subdirectorios menos importantes para mantener la claridad.