Skip to content

Latest commit

 

History

History
194 lines (146 loc) · 5.43 KB

README.md

File metadata and controls

194 lines (146 loc) · 5.43 KB
Raw

Qué es Kimkëlen

Kimkëlen es un sistema de gestión integrada de colegios secundarios realizado por el CeSPI perteneciente a la Universidad Nacional de La Plata UNLP. El sistema permite personalización a través de comportamientos o behaviors; cada comportamiento permite definir formas de evaluación según lo resuelva el colegio, seguimiento de inasistencias, sanciones disciplinarias, impresión de boletines, generación de reportes, etcétera.

Instalación

Editar la configuración de la base de datos

La configuración de la base de datos se realiza por medio de los archivos databases.yml y propel.ini. Se proveen estos archivos a modo de ejemplo en el directorio config/

cp config/databases.yml-default config/databases.yml
cp config/propel.ini-default config/propel.ini

Edite estos archivos según la configuración de su entorno.

Ejemplo de databases.yml

....
all:
  propel:
    class:        sfPropelDatabase
    param:
      classname:  PropelPDO
      dsn:        mysql:dbname=kimkelen;host=localhost
      username:   root
      password:   
      encoding:   utf8
      persistent: true
      pooling:    true

Ejemplo de propel.ini

propel.targetPackage       = lib.model
propel.packageObjectModel  = true
propel.project             = conservatorio
propel.database            = mysql
propel.database.driver     = mysql
propel.database.url        = mysql:dbname=kimkelen;host=localhost
propel.database.creole.url = ${propel.database.url}
propel.database.user       = root
propel.database.password   = 
propel.database.encoding   = utf8
...

Es importante destacar que la base de datos debe crearla manualmente, no es creada por ninguno de los pasos siguientes

Correr los siguientes comandos

php symfony kimkelen:flavor <COMPORTAMIENTO>
php symfony propel:build-all-load 
php symfony plugin:publish
php symfony project:permissions

En el caso de que al ejecutar el comando "php symfony propel:build-all-load" se produzca algún error, reemplazar la ejecución del misimo por la ejecución de los siguientes comandos

php symfony propel:build-model
php symfony propel:build-forms
php symfony propel:build-filters
php symfony propel:build-sql
php symfony propel:insert-sql

¿Qué es el comportamiento o sabor?

Cada colegio tiene su propio esquema de enseñanza siguiendo reglas diferentes. Kimelen provee una forma desacoplada de programar esta lógica en lo que llamamos sabores o comportamientos

El primer comando de la lista anterior setea el comportamiento del colegio. Considere que los comportamientos disponibles son los que se encuentran bajo el directorio flavors/

Un ejemplo entonces, sería:

php symfony kimkelen:flavor demo

Datos iniciales

El sistema se instala con algunos datos cargados a decir:

  • Usuarios: usuarios del sistema

    • Administrador:
      • username: admin
      • password: @dm1n1strad0r
    • Preceptor:
      • username: preceptor
      • password: @pr3c3pt0r
    • Profesor:
      • username: profesor
      • password: @pr0f3s0r

  • Año lectivo: se creará un año lectivo en estado vigente

  • Plan de estudios: No se crean planes de estudio Esto debe crearlo cada colegio. Queremos permitir que cada colegio done su plan de estudios, así lo pueden compartir con otros colegios.

Instalación con Capistrano

Recomendamos darle una oportunidad a este excelente producto. Leer más aqui

Editar el Gemfile agregando

source "https://rubygems.org"
gem "capifony"

Correr el comando bundle update en la raiz del proyecto

Luego capificar la aplicación:

cd ROOT_KIMKELEN
capifony .

Editar el archivo config/deploy.rb

Ejemplo de archivo config/deploy.rb

set :flavor, "demo"
set :ssh_options, { :forward_agent => true }
set :application, "kimekelen"
set :user, application
set :domain,      "desarrollo.cespi.unlp.edu.ar"
set :deploy_to,   "/opt/applications/#{application}"

set :repository,  "https://github.com/Desarrollo-CeSPI/kimkelen.git"
set :scm,         :git

role :web,        domain                         # Your HTTP server, Apache/etc
role :app,        domain                         # This may be the same as your `Web` server
role :db,         domain, :primary => true       # This is where symfony migrations will run

set :deploy_via, :remote_cache
set   :use_sudo,      false
set  :keep_releases,  3
set :symfony_version, "1.2.13"
set :use_orm, false
set :shared_files, %w(config/databases.yml config/app.yml)

 after "deploy:finalize_update" do
   symfony.propel.setup
    # Build classes
       run "#{try_sudo} #{php_bin} #{latest_release}/symfony propel:build-model"
       run "#{try_sudo} #{php_bin} #{latest_release}/symfony propel:build-forms"
       run "#{try_sudo} #{php_bin} #{latest_release}/symfony propel:build-filters"

    # Emulate
       run "#{try_sudo} #{php_bin} #{latest_release}/symfony kimkelen:flavor #{flavor} "

  symfony.cc
  symfony.plugin.publish_assets
  symfony.project.permissions
 end

Comandos a correr

cap deploy:setup
cap deploy

Resta conectarse y correr el comando:

php symfony kimkelen:flavor <comportamiento>

Los comportamientos se definen en el directorio flavors. El comportamiento por defecto sería demo

TODO

  • El app.yml queda vacío por lo que hay que copiarlo manualmente. Deberíamos hacer que en el primer deploy se copie