Centro de Notificación ISC

Sistema de notificaciones del programa de Ingeniería en Sistemas y Computación (ISC) de la Universidad Tecnológica de Pereira

Actualmente, el programa ISC emplea una lista de correos para comunicarse con los estudiantes del programa. Esta aplicación se ha creado para solucionar y optimizar la forma en que se manejan y gestionan las notificaciones a través de una plataforma web interactiva que permita mayor privacidad, seguridad, flexibilidad, confiabilidad y segmentación a la hora de comunicarse con los estudiantes y profesores.

Esta aplicación hace parte del proyecto de grado: Sistema de Gestión de Actividades del Programa ISC-UTP, presentado por:

• Vanesa Gómez Londoño
• Daniel A. Bernal
• Jonathan Álvarez González
• Carlos A. Meneses (D)

Dependencias

Es necesario tener instalado Git, Python (>=2.7) y Node.js (>=0.10) para correr la aplicación.

Aunque es opcional, se recomienda instalar la aplicación en un entorno virtual virtualenv de Python para que las dependencias instaladas no causen conflictos. En la instalación hacemos uso del wrapper virtualenvwrapper

También se ha utilizado PIP de Python para manejar paquetes. Debe instalarse.

Instalación

1. Clonar el repositorio usando git

    $ git clone https://github.com/tamarindo/CNISC.git && cd CNISC
   

2. Recomendación: Iniciar un nuevo entorno virtual virtualenv

    $ mkvirtualenv cniscenv
   

3. Sincronizar paquetes y base de datos

   Se instalarán los paquetes necesarios a través de los gestores pip, npm y bower. Además se sincronizará la base de datos. El proceso pedirá crear un nuevo super usuario para la Aplicación.

    $ make install
    $ make migrate
   

4. Compilar assets

    $ gulp
   

5. Iniciar servidor

    $ make run
   

La aplicación será accesible desde http://127.0.0.1:8000/

Convenciones

Los nombres de funciones se definen bajo las siguientes convenciones

• URL: En español separadas por guión medio. Ej: http://dominio.com/panel-de-control

• Nombres de funciones: tanto backend como frontend: Camel case en idioma inglés. Ej: someFunction()

• Nombres de las clases CSS: En inglés separadas por guión medio. Ej: some-css-class

• Nombres de id en CSS: En español separados por guión medio. Ej: estudiante-21

• Configuración de los editores de texto: Están definidas en el archivo .editorconfig la mayoría de los editores reconocerán este archivo y utilizaran su formato al abrir el proyecto en el mismo.

• Comentarios: Utilizar comentarios en bloque /* */ sólo para documentaciones extensas. Utilizar comentarios inline // sólo para comentar lineas de código en particular. En Python utilizar sólo el símbolo # para ambos tipos de comentarios.

    /*
     * Some function
     * Demostrative function that does nothing
    */
    var someFunction = function( obj ) {
    	obj.name = 'New name'; // Inline comment. Dont make comments for self explaneatory lines.
    	
    	return obj;
    }