Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bytelu/pscg-management-monitoring-and-control-platform
Web application developed in Django for the “General Directorate of Coordination of Internal Control Bodies Sectoral C of the SCG CDMX” to automate the extraction of data from different sources and use them in supervision activities. This includes data management and the generation of documents in Excel and Word.
https://github.com/bytelu/pscg-management-monitoring-and-control-platform
django-application django-project html-css-javascript mysql
Last synced: 10 days ago
JSON representation
Web application developed in Django for the “General Directorate of Coordination of Internal Control Bodies Sectoral C of the SCG CDMX” to automate the extraction of data from different sources and use them in supervision activities. This includes data management and the generation of documents in Excel and Word.
- Host: GitHub
- URL: https://github.com/bytelu/pscg-management-monitoring-and-control-platform
- Owner: bytelu
- License: mit
- Created: 2024-07-26T19:57:30.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-10-18T19:07:19.000Z (3 months ago)
- Last Synced: 2024-10-19T13:41:20.246Z (3 months ago)
- Topics: django-application, django-project, html-css-javascript, mysql
- Language: HTML
- Homepage:
- Size: 4.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
README
PSCG
**PSCG** es una aplicación integral desarrollada con Django, diseñada para optimizar la gestión y supervisión en el
ámbito de actividades de fiscalización. Esta plataforma ofrece herramientas avanzadas para:
- **Gestión de Datos**: Administra y organiza datos relacionados con auditorías, controles internos e intervenciones.
- **Supervisión Eficiente**: Facilita la supervisión de actividades mediante una interfaz centralizada y herramientas
especializadas.
- **Generación de Archivos**: Permite la generación de archivos necesarios para llevar a cabo las actividades de
supervisión de fiscalización de manera efectiva.
Con **PSCG**, se podrá mejorar la eficiencia de la realización de los procesos de supervisión de fiscalización,
asegurando un control riguroso y detallado de las actividades.
## Tabla de Contenidos
- [Introducción](#introducción)
- [Instalación](#instalación)
- [Uso](#uso)
- [Documentación](#documentación)
- [Conclusión](#conclusión)
- [Contribuidores](#contribuidores)
- [Licencia](#licencia)
- [Contacto](#contacto)
- [Disclaimer](#disclaimer)
## Introducción
**PSCG** (Plataforma de Supervisión y Control de Gestión) es una herramienta integral desarrollada con Django, diseñada
para optimizar la gestión y supervisión en el ámbito de actividades de fiscalización. Esta plataforma ofrece un conjunto
completo de funcionalidades para administrar, organizar y supervisar auditorías, intervenciones y controles internos de
manera eficiente y centralizada.
**PSCG** permite a los usuarios:
- **Gestionar Datos de Auditorías**: Administra y organiza todos los datos relacionados con auditorías, incluyendo la
capacidad de agregar, editar y eliminar registros de manera intuitiva.
- **Supervisión de Actividades**: Facilita la supervisión de actividades mediante una interfaz centralizada y
herramientas especializadas para las distintas actividades de fiscalización, asegurando que todos los procesos cumplan
con los estándares requeridos.
- **Generación de Archivos para Supervisión**: Genera automáticamente los archivos necesarios para llevar a cabo
actividades de supervisión de fiscalización de manera efectiva, ahorrando tiempo y minimizando errores.
Con **PSCG**, se puede mejorar la eficiencia y efectividad de los procesos de fiscalización, asegurando un control
riguroso y detallado de todas las actividades.
Esta documentación te guiará a través de los siguientes aspectos del proyecto:
- Instalación: Cómo instalar y configurar **PSCG** en tu entorno local.
- Uso: Una guía detallada sobre cómo utilizar las diversas funcionalidades de la plataforma.
- Contribución: Instrucciones sobre cómo contribuir al desarrollo de **PSCG**, incluyendo cómo reportar problemas y
enviar mejoras.
Esperamos que esta herramienta sea de gran ayuda e invitamos a contribuir para su mantenimiento y mejora.
## Instalación
### Requisitos
- Python: Versión 3.12 o superior.
- Django: Versión 5.0.4.
- Base de datos: PostgreSQL, MySQL o similar.
### Pasos para la Instalación
1. Clona el repositorio:
```shell
git clone https://github.com/bytelu/PSCG.git
cd tu_repositorio
```
2. Crear y activar un entorno virtual:
Es recomendable usar un entorno virtual para gestionar las dependencias del proyecto. Para crear y activar un entorno
virtual, ejecuta los siguientes comandos:
```shell
python3 -m venv .venv
source .venv/bin/activate # En Windows usa `.venv\Scripts\activate`
```
3. Instalar dependencias:
```shell
pip install -r requirements.txt
```
4. Configurar la base de datos:
Para este paso se tiene que tener creada una base de datos con anterioridad para uso de la aplicación.
En el archivo `settings.py`, configura tu base de datos:
```python
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql', # O el correspondiente a tu base de datos
'NAME': 'nombre_de_tu_base_de_datos',
'USER': 'tu_usuario',
'PASSWORD': 'tu_contraseña',
'HOST': 'localhost',
'PORT': '3306', # O el puerto correspondiente a tu base de datos
}
}
```
5. Aplicar las migraciones:
Aplica las migraciones para crear las tablas necesarias en la base de datos:
```shell
python manage.py migrate
```
6. Crear un superusuario:
Sigue las instrucciones indicadas después de ejecutar el siguiente comando:
```shell
python manage.py createsuperuser
```
7. Cargar datos iniciales:
Carga los datos iniciales para el correcto funcionamiento:
```shell
python manage.py loaddata initial_data.json
```
8. Verificar las configuraciones:
Se necesita verificar que la base de datos se encuentra corriendo y con los datos
iniciales cargados, para ello puede ir al shell y acceder a su base de datos, a continuación se muestra un
ejemplo de
ejecución en Windows.
```shell
cd "C:\Program Files\MySQL\MySQL Server 8.0\bin"
```
Para acceder a la ruta de instalación de MySQL.
```shell
mysql -u username -p
```
Donde se reemplaza username con su nombre de usuario configurado en la instalación y a continuación le pedirá
ingresar password, la cual en caso de haber sido configurada, debera de ingresar, en caso contrario se dejara el
espacio vació y se dara enter.
Si se ingreso correctamente y la base de datos se encuentra corriendo, se vera el promp en este caso de
MySQL (`mysql>`), lo que indica que la conexión se ha establecido correctamente.
Después de ello se deberán de mostrar las bases de datos, para confirmar que se encuentra la base de datos
configurada
en el archivo de configuración de Django.
```mysql
SHOW DATABASES;
```
Después de ello se accede a la base de datos, y se muestran las tablas para verificar su existencia.
```mysql
show tables
```
Si se muestran todas las tablas de la base de datos, se procede a la verificación de los datos iniciales, por ello se
accede a las tablas de:
- clasificacion
- enfoque
- materia
- oic
- programa_revision
- programacion
- temporalidad
- tipo_cargo
- tipo_intervencion
- tipo_minuta
- tipo_revision
```mysql
use oicsec;
select * from clasificacion;
```
si se muestran los datos correspondientes dentro de la base de datos, sera la ultima verificación a realizar y se
estará listo para proseguir.
9. Ejecutar el servidor de desarrollo:
```shell
python manage.py runserver
```
Accede a la aplicación en tu navegador en: [http://127.0.0.1:8000](http://127.0.0.1:8000).
## Uso
> También puedes probar a consultar el manual de usuario en: [manual de usuario](user_manual/introduction.md)
Una vez que el proyecto esté instalado y corriendo, puedes usar las siguientes funcionalidades:
Con las claves del superusuario se puede acceder a la página principal del sistema en la página de login, para ello
ingresa a [http://127.0.0.1:8000](http://127.0.0.1:8000), esto te redirigirá automáticamente a la pantalla de login. Una
vez dentro, simplemente prueba a ingresar tus claves.
Con esto se ingresará al sistema y serás dirigido a la página de home:
Una vez dentro, puedes acceder a las funcionalidades implementadas con el botón de sidebar ubicado en la parte superior
izquierda de la página, o arrastrando con el mouse desde la parte izquierda.
Dentro de estas opciones se cuenta con:
- Home
- Auditorías
- Intervenciones
- Controles Internos
- Personal
Cada una de estas opciones, a excepción de home, cuenta con un menú desplegable, con el cual se puede acceder a
distintas interfaces.
En primera instancia se encuentran las actividades principales que son auditorías, intervenciones y controles internos.
Estas tienen una sección a la cual se accede presionando el botón correspondiente y seleccionando la opción **Mostrar "
Nombre correspondiente"**, donde se puede visualizar cada una de las que han sido registradas en el sistema. Se cuenta
con un filtro en cada una de ellas para filtrar por OIC y Año para una búsqueda más rápida y sencilla.
A un costado de cada una de estas páginas, en la parte superior derecha, se encuentra un botón con la simbología
de 
, al cual al darle clic redirecciona a una página
de subida de archivo, en donde se podrá subir un archivo de acuerdo a los formatos utilizados en la dirección de la
contraloría, para subir la correspondiente actividad de fiscalización, ya sea auditoría, control interno o intervención.
Una vez subido, se debería visualizar en su correspondiente sección, y al darle clic, se deberían mostrar sus detalles
por medio de un formulario el cual permite modificarlos de acuerdo a cualquier necesidad, para poder guardar los datos
si es que se modificaron con el botón de la parte inferior, o en su otro caso, borrar la actividad con el símbolo
de 
, se muestra un ejemplo del formulario:
Al tener actividades registradas, se puede acceder a un menú a un lado de la actividad con el
símbolo en el ítem dentro del listado. Este
despliega un modal desde el cual el usuario accede a las funcionalidades de supervisión de la actividad de
fiscalización, ya sea que se opte por la realización de una minuta de supervisión o una cédula de supervisión, estos
conteniendo su estructura dependiendo de las actividades que realiza un OIC durante el mes para las minutas, o una
cédula para cada actividad realizada, siendo ambos tipos de archivos divididos para su realización por mes durante la
duración del periodo del trimestre, en donde cada uno de los archivos cuenta con un formulario específico por mes el
cual podrá generar un archivo para su posterior uso. Siendo estos archivos generados, plantillas usadas en la dirección
de coordinación.
###### Modal de acceso a actividades de supervisión:
###### Panel de selección de mes de minuta
###### Formulario de relleno de datos correspondientes a cédula
Para la realización de las actividades de supervisión en la sección de las minutas se necesita que los datos de los
interesados de las minutas se encuentren presentes dentro de la base de datos. Por ello se realizó un sistema de gestión
de usuarios con asignación de roles para las firmas de las minutas, los cuales se deben agregar en la sección de
personal. Aquí se encuentra el listado de los mismos, donde se cuenta con un filtro por nombre para una búsqueda más
rápida, donde al darle clic se muestra un formulario con todos los datos del personal, además de roles de usuario, y los
cuales se puede eliminar o modificar.
###### Panel de OIC's
###### Panel de personal de OIC
###### Formulario de creación de titular
###### Formulario de creación de personal de OIC
###### Panel de edición de personal con asignación de cargos
Por último, en la esquina superior derecha de la página, se encuentran dos botones los cuales permiten cerrar la sesión,
o acceder a la información de perfil del usuario, respectivamente.
## Documentación
Para acceder a información mas detallada, se puede acceder a los archivos
de [documentación de desarrollador](developer_manual) o a los archivos
de [documentación de despliegue](deployment_manual), también se puede obtener información sobre los test realizados en [tests](tests), ademas
de como ya se menciono, tener acceso a los [manuales de usuario](user_manual), donde se tiene una introducción al
sistema, y una guia de errores que pueden surgir durante su uso y como tratarlos.
## Conclusión
Este proyecto ha sido desarrollado para proporcionar una herramienta integral que facilita la gestión y monitoreo de
estos procesos críticos de supervisión. A través de la implementación de tecnologías clave como Django para el backend y
un diseño optimizado en HTML para la presentación de datos, se ha logrado crear un sistema que no solo mejora la
eficiencia operativa, sino que también asegura la integridad y transparencia en el manejo de la información.
Los resultados alcanzados demuestran que la solución es capaz de centralizar y automatizar tareas que anteriormente se
realizaban manualmente, reduciendo significativamente los errores y tiempos de respuesta. Además, se ha logrado una
interfaz de usuario intuitiva, que permite una interacción sencilla y eficiente con el sistema.
En conclusión, este proyecto no solo cumple con los objetivos planteados, sino que también establece una base sólida
para futuras mejoras y expansiones.
## Contribuidores
- [bytelu](https://github.com/bytelu) - Creador
PSCG aun se encuentra en desarrollo, cualquier feedback, sugerencias y contribuciones, son valiosas para mi.
## Licencia
**PSCG** es un software con todos los derechos reservados. Para más información, consulta el
archivo [LICENSE.md](../LICENSE) incluido
en este repositorio.
## Contacto
Si tienes alguna pregunta, comentario o necesitas asistencia, no dudes en ponerte en contacto:
- **Correo Electrónico**: [[email protected]](mailto:[email protected])
- **GitHub**: [github.com/bytelu](https://github.com/bytelu)
También puedes abrir un [issue](https://github.com/bytelu/PSCG/issues) en el repositorio para reportar problemas o hacer
sugerencias.
## Disclaimer
PSCG es desarrollado para la entidad denominada "Dirección General de Coordinación de Órganos internos C", sin embargo
su uso no quedando limitado a ello, puesto que no se ha firmado contrato alguno para la realización especifica del
software, ni se ha recibido remuneración por ello, por eso el creador no asume ninguna responsabilidad del uso del
mismo, su clonación o su integración para otros fines.