+
+ + https://cyc-bpo.com/
+ PBX: (601)7461166-Ext: 8081
+ Calle 19 #3-16 | Piso 3-CC Barichara
+ Bogotá D.C.-Colombia +
+ Este correo electrónico y cualquier archivo adjunto son confidenciales y pueden contener información privilegiada. Si usted no es el destinatario correcto, por favor notifique al remitente respondiendo este mensaje y elimine inmediatamente este correo electrónico y cualquier archivo adjunto de su sistema. Si está usted recibiendo este correo electrónico por error, no debe copiar este mensaje o divulgar su contenido a ninguna persona. +
"""
if settings.DEBUG or "test" in sys.argv:
- to_emails = ["heibert.mogollon@cyc-bpo.com"]
+ to_emails = [settings.EMAIL_FOR_TEST]
else:
to_emails = ["contrataciones@cyc-bpo.com"]
errors = send_email(
@@ -93,8 +93,8 @@ def send_vacancy_apply(request):
subject = f"Aplicación a {vacancy}"
user = User.objects.get(username=request.user)
if user.cedula == 999999999 or settings.DEBUG or "test" in sys.argv:
- cedula = "1000065648"
- to_emails = ["heibert.mogollon@cyc-bpo.com"]
+ cedula = settings.TEST_CEDULA
+ to_emails = [settings.EMAIL_FOR_TEST]
else:
cedula = user.cedula
to_emails = ["contrataciones@cyc-bpo.com"]
diff --git a/INSIGHTSAPI/vacation/__init__.py b/INSIGHTSAPI/vacation/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/INSIGHTSAPI/vacation/admin.py b/INSIGHTSAPI/vacation/admin.py
new file mode 100644
index 0000000..8c38f3f
--- /dev/null
+++ b/INSIGHTSAPI/vacation/admin.py
@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.
diff --git a/INSIGHTSAPI/vacation/apps.py b/INSIGHTSAPI/vacation/apps.py
new file mode 100644
index 0000000..ffa6e9a
--- /dev/null
+++ b/INSIGHTSAPI/vacation/apps.py
@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class VacationConfig(AppConfig):
+ default_auto_field = 'django.db.models.BigAutoField'
+ name = 'vacation'
diff --git a/INSIGHTSAPI/vacation/factories.py b/INSIGHTSAPI/vacation/factories.py
new file mode 100644
index 0000000..3b12b8c
--- /dev/null
+++ b/INSIGHTSAPI/vacation/factories.py
@@ -0,0 +1,22 @@
+import factory
+from vacation.models import VacationRequest
+
+
+class VacationFactory(factory.django.DjangoModelFactory):
+ class Meta:
+ model = VacationRequest
+
+ user = factory.SubFactory("users.factories.UserFactory")
+ start_date = factory.Faker("date")
+ end_date = factory.Faker("date")
+ request_file = factory.django.FileField(filename="test.pdf")
+ uploaded_by = factory.SubFactory("users.factories.UserFactory")
+ manager_approbation = factory.Faker("boolean")
+ hr_approbation = factory.Faker("boolean")
+ payroll_approbation = factory.Faker("boolean")
+ status = factory.Faker("random_element", elements=["PENDIENTE", "APROBADA", "RECHAZADA", "CANCELADA"])
+ comment = factory.Faker("text")
+ uploaded_at = factory.Faker("date_time_this_month")
+ manager_approved_at = factory.Faker("date_time_this_month")
+ hr_approved_at = factory.Faker("date_time_this_month")
+ payroll_approved_at = factory.Faker("date_time_this_month")
\ No newline at end of file
diff --git a/INSIGHTSAPI/vacation/migrations/0001_initial.py b/INSIGHTSAPI/vacation/migrations/0001_initial.py
new file mode 100644
index 0000000..89dda82
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0001_initial.py
@@ -0,0 +1,25 @@
+# Generated by Django 5.0.2 on 2024-05-21 13:34
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ initial = True
+
+ dependencies = [
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name='VacationRequest',
+ fields=[
+ ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+ ('employee_name', models.CharField(max_length=100)),
+ ('start_date', models.DateField()),
+ ('end_date', models.DateField()),
+ ('reason', models.TextField()),
+ ('request_pdf', models.FileField(upload_to='vacation_requests/')),
+ ],
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0002_vacationrequest_uploaded_at_and_more.py b/INSIGHTSAPI/vacation/migrations/0002_vacationrequest_uploaded_at_and_more.py
new file mode 100644
index 0000000..19fdd99
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0002_vacationrequest_uploaded_at_and_more.py
@@ -0,0 +1,26 @@
+# Generated by Django 5.0.2 on 2024-05-23 11:52
+
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0001_initial'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='uploaded_at',
+ field=models.DateTimeField(auto_now_add=True, default=django.utils.timezone.now),
+ preserve_default=False,
+ ),
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='uploaded_by',
+ field=models.CharField(default=1, max_length=100),
+ preserve_default=False,
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0003_alter_vacationrequest_uploaded_by.py b/INSIGHTSAPI/vacation/migrations/0003_alter_vacationrequest_uploaded_by.py
new file mode 100644
index 0000000..7931305
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0003_alter_vacationrequest_uploaded_by.py
@@ -0,0 +1,21 @@
+# Generated by Django 5.0.2 on 2024-05-23 16:33
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0002_vacationrequest_uploaded_at_and_more'),
+ migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='vacationrequest',
+ name='uploaded_by',
+ field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0004_rename_request_pdf_vacationrequest_request_file.py b/INSIGHTSAPI/vacation/migrations/0004_rename_request_pdf_vacationrequest_request_file.py
new file mode 100644
index 0000000..4728094
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0004_rename_request_pdf_vacationrequest_request_file.py
@@ -0,0 +1,18 @@
+# Generated by Django 5.0.2 on 2024-05-23 16:55
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0003_alter_vacationrequest_uploaded_by'),
+ ]
+
+ operations = [
+ migrations.RenameField(
+ model_name='vacationrequest',
+ old_name='request_pdf',
+ new_name='request_file',
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0005_remove_vacationrequest_employee_name_and_more.py b/INSIGHTSAPI/vacation/migrations/0005_remove_vacationrequest_employee_name_and_more.py
new file mode 100644
index 0000000..7022f9b
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0005_remove_vacationrequest_employee_name_and_more.py
@@ -0,0 +1,31 @@
+# Generated by Django 5.0.2 on 2024-05-31 15:32
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0004_rename_request_pdf_vacationrequest_request_file'),
+ migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name='vacationrequest',
+ name='employee_name',
+ ),
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='user',
+ field=models.ForeignKey(default=1, on_delete=django.db.models.deletion.CASCADE, related_name='vacation_requests', to=settings.AUTH_USER_MODEL),
+ preserve_default=False,
+ ),
+ migrations.AlterField(
+ model_name='vacationrequest',
+ name='uploaded_by',
+ field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='uploaded_requests', to=settings.AUTH_USER_MODEL),
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0006_vacationrequest_hr_approved_and_more.py b/INSIGHTSAPI/vacation/migrations/0006_vacationrequest_hr_approved_and_more.py
new file mode 100644
index 0000000..d339726
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0006_vacationrequest_hr_approved_and_more.py
@@ -0,0 +1,23 @@
+# Generated by Django 5.0.2 on 2024-06-06 15:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0005_remove_vacationrequest_employee_name_and_more'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='hr_approved',
+ field=models.BooleanField(default=False),
+ ),
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='hr_approved_at',
+ field=models.DateTimeField(blank=True, null=True),
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0007_remove_vacationrequest_reason.py b/INSIGHTSAPI/vacation/migrations/0007_remove_vacationrequest_reason.py
new file mode 100644
index 0000000..8542c26
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0007_remove_vacationrequest_reason.py
@@ -0,0 +1,17 @@
+# Generated by Django 5.0.2 on 2024-06-06 16:17
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0006_vacationrequest_hr_approved_and_more'),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name='vacationrequest',
+ name='reason',
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0008_vacationrequest_observation_vacationrequest_status.py b/INSIGHTSAPI/vacation/migrations/0008_vacationrequest_observation_vacationrequest_status.py
new file mode 100644
index 0000000..e729d65
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0008_vacationrequest_observation_vacationrequest_status.py
@@ -0,0 +1,23 @@
+# Generated by Django 5.0.2 on 2024-06-11 11:55
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0007_remove_vacationrequest_reason'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='observation',
+ field=models.TextField(blank=True, null=True),
+ ),
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='status',
+ field=models.CharField(choices=[('PENDING', 'PENDING'), ('APPROVED', 'APPROVED'), ('REJECTED', 'REJECTED'), ('CANCELLED', 'CANCELLED')], default='PENDING', max_length=100),
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0009_rename_observation_vacationrequest_comment.py b/INSIGHTSAPI/vacation/migrations/0009_rename_observation_vacationrequest_comment.py
new file mode 100644
index 0000000..cb0c3f4
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0009_rename_observation_vacationrequest_comment.py
@@ -0,0 +1,18 @@
+# Generated by Django 5.0.2 on 2024-06-11 11:57
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0008_vacationrequest_observation_vacationrequest_status'),
+ ]
+
+ operations = [
+ migrations.RenameField(
+ model_name='vacationrequest',
+ old_name='observation',
+ new_name='comment',
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0010_alter_vacationrequest_hr_approved.py b/INSIGHTSAPI/vacation/migrations/0010_alter_vacationrequest_hr_approved.py
new file mode 100644
index 0000000..2981948
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0010_alter_vacationrequest_hr_approved.py
@@ -0,0 +1,18 @@
+# Generated by Django 5.0.2 on 2024-06-11 15:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0009_rename_observation_vacationrequest_comment'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='vacationrequest',
+ name='hr_approved',
+ field=models.BooleanField(blank=True, null=True),
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0011_rename_hr_approved_vacationrequest_hr_approbation_and_more.py b/INSIGHTSAPI/vacation/migrations/0011_rename_hr_approved_vacationrequest_hr_approbation_and_more.py
new file mode 100644
index 0000000..7ee7145
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0011_rename_hr_approved_vacationrequest_hr_approbation_and_more.py
@@ -0,0 +1,38 @@
+# Generated by Django 5.0.2 on 2024-06-13 10:12
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0010_alter_vacationrequest_hr_approved'),
+ ]
+
+ operations = [
+ migrations.RenameField(
+ model_name='vacationrequest',
+ old_name='hr_approved',
+ new_name='hr_approbation',
+ ),
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='manager_approbation',
+ field=models.BooleanField(blank=True, null=True),
+ ),
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='manager_approved_at',
+ field=models.DateTimeField(blank=True, null=True),
+ ),
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='payroll_approbation',
+ field=models.BooleanField(blank=True, null=True),
+ ),
+ migrations.AddField(
+ model_name='vacationrequest',
+ name='payroll_approved_at',
+ field=models.DateTimeField(blank=True, null=True),
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0012_alter_vacationrequest_options_and_more.py b/INSIGHTSAPI/vacation/migrations/0012_alter_vacationrequest_options_and_more.py
new file mode 100644
index 0000000..2bd9ea2
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0012_alter_vacationrequest_options_and_more.py
@@ -0,0 +1,22 @@
+# Generated by Django 5.0.2 on 2024-06-13 16:51
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0011_rename_hr_approved_vacationrequest_hr_approbation_and_more'),
+ ]
+
+ operations = [
+ migrations.AlterModelOptions(
+ name='vacationrequest',
+ options={'permissions': [('payroll_approbation', 'Can approve payroll')]},
+ ),
+ migrations.AlterField(
+ model_name='vacationrequest',
+ name='status',
+ field=models.CharField(choices=[('PENDIENTE', 'PENDIENTE'), ('APROBADA', 'APROBADA'), ('RECHAZADA', 'RECHAZADA'), ('CANCELADA', 'CANCELADA')], default='PENDIENTE', max_length=100),
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/0013_alter_vacationrequest_request_file.py b/INSIGHTSAPI/vacation/migrations/0013_alter_vacationrequest_request_file.py
new file mode 100644
index 0000000..79ffbdc
--- /dev/null
+++ b/INSIGHTSAPI/vacation/migrations/0013_alter_vacationrequest_request_file.py
@@ -0,0 +1,18 @@
+# Generated by Django 5.0.2 on 2024-07-03 14:45
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('vacation', '0012_alter_vacationrequest_options_and_more'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='vacationrequest',
+ name='request_file',
+ field=models.FileField(upload_to='files/vacation_requests/'),
+ ),
+ ]
diff --git a/INSIGHTSAPI/vacation/migrations/__init__.py b/INSIGHTSAPI/vacation/migrations/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/INSIGHTSAPI/vacation/models.py b/INSIGHTSAPI/vacation/models.py
new file mode 100644
index 0000000..f10149b
--- /dev/null
+++ b/INSIGHTSAPI/vacation/models.py
@@ -0,0 +1,91 @@
+"""This module contains the model for the vacation request """
+
+from django.db import models
+from users.models import User
+from notifications.utils import create_notification
+from django.utils import timezone
+
+
+class VacationRequest(models.Model):
+ """Model for the vacation request"""
+
+ user = models.ForeignKey(
+ User, on_delete=models.CASCADE, related_name="vacation_requests"
+ )
+ start_date = models.DateField()
+ end_date = models.DateField()
+ request_file = models.FileField(upload_to="files/vacation_requests/")
+ uploaded_at = models.DateTimeField(auto_now_add=True)
+ manager_approbation = models.BooleanField(null=True, blank=True)
+ manager_approved_at = models.DateTimeField(null=True, blank=True)
+ hr_approbation = models.BooleanField(null=True, blank=True)
+ hr_approved_at = models.DateTimeField(null=True, blank=True)
+ payroll_approbation = models.BooleanField(null=True, blank=True)
+ payroll_approved_at = models.DateTimeField(null=True, blank=True)
+ status = models.CharField(
+ choices=[
+ ("PENDIENTE", "PENDIENTE"),
+ ("APROBADA", "APROBADA"),
+ ("RECHAZADA", "RECHAZADA"),
+ ("CANCELADA", "CANCELADA"),
+ ],
+ max_length=100,
+ default="PENDIENTE",
+ )
+ comment = models.TextField(null=True, blank=True)
+ uploaded_by = models.ForeignKey(
+ "users.User", on_delete=models.CASCADE, related_name="uploaded_requests"
+ )
+
+ class Meta:
+ """Meta class for the vacation request model."""
+
+ permissions = [
+ ("payroll_approbation", "Can approve payroll"),
+ ]
+
+ @property
+ def duration(self):
+ """Return the duration of the vacation request."""
+ return (self.end_date - self.start_date).days
+
+ def __str__(self):
+ return f"{self.user} - {self.start_date} - {self.end_date}"
+
+ def save(self, *args, **kwargs):
+ """Override the save method to update status and create notifications."""
+ approbation_fields = {
+ "manager_approbation": "manager_approved_at",
+ "hr_approbation": "hr_approved_at",
+ "payroll_approbation": "payroll_approved_at",
+ }
+
+ for field, approved_at in approbation_fields.items():
+ approbation = getattr(self, field)
+ if approbation is not None:
+ if not approbation:
+ self.status = "RECHAZADA"
+ setattr(self, approved_at, timezone.now())
+
+ if all(getattr(self, field) for field in approbation_fields):
+ self.status = "APROBADA"
+ if self.status == "APROBADA":
+ create_notification(
+ f"Solicitud de vacaciones aprobada",
+ f"Tus vacaciones del {self.start_date} al {self.end_date} han sido aprobadas. Esperamos que las disfrutes ⛱!.",
+ self.user,
+ )
+ elif self.status == "RECHAZADA":
+ create_notification(
+ f"Solicitud de vacaciones rechazada",
+ f"Tu solicitud de vacaciones del {self.start_date} al {self.end_date} ha sido rechazada.",
+ self.user,
+ )
+ elif self.status == "CANCELADA":
+ create_notification(
+ f"Solicitud de vacaciones cancelada",
+ f"Tu solicitud de vacaciones del {self.start_date} al {self.end_date} ha sido cancelada.",
+ self.user,
+ )
+ super().save(*args, **kwargs)
+
diff --git a/INSIGHTSAPI/vacation/serializers.py b/INSIGHTSAPI/vacation/serializers.py
new file mode 100644
index 0000000..d81bbd9
--- /dev/null
+++ b/INSIGHTSAPI/vacation/serializers.py
@@ -0,0 +1,103 @@
+"""Serializers for the vacation app."""
+
+from rest_framework import serializers
+from users.models import User
+from .models import VacationRequest
+
+
+class VacationRequestSerializer(serializers.ModelSerializer):
+ """Serializer for the vacation request model."""
+
+ start_date = serializers.DurationField
+ user = serializers.PrimaryKeyRelatedField(queryset=User.objects.all())
+ uploaded_by = serializers.PrimaryKeyRelatedField(
+ read_only=True, default=serializers.CurrentUserDefault()
+ )
+
+ class Meta:
+ """Meta class for the serializer."""
+
+ model = VacationRequest
+ fields = [
+ "id",
+ "user",
+ "start_date",
+ "end_date",
+ "request_file",
+ "uploaded_at",
+ "manager_approbation",
+ "manager_approved_at",
+ "hr_approbation",
+ "hr_approved_at",
+ "payroll_approbation",
+ "payroll_approved_at",
+ "uploaded_by",
+ "status",
+ "comment",
+ ]
+ read_only_fields = [
+ "manager_approved_at",
+ "hr_approved_at",
+ "payroll_approved_at",
+ "uploaded_by",
+ "uploaded_at",
+ ]
+
+ def to_representation(self, instance):
+ """Return the representation of the vacation request."""
+ data = super().to_representation(instance)
+ data["user"] = instance.user.get_full_name()
+ data["uploaded_by"] = instance.uploaded_by.get_full_name()
+ data.pop("manager_approved_at")
+ data.pop("hr_approved_at")
+ data.pop("payroll_approved_at")
+ return data
+
+ def validate(self, attrs):
+ """Validate the dates of the vacation request."""
+ if "start_date" in attrs and "end_date" in attrs:
+ if attrs["start_date"] > attrs["end_date"]:
+ raise serializers.ValidationError(
+ "La fecha de inicio no puede ser mayor a la fecha de fin."
+ )
+ uploaded_by = (
+ self.instance.uploaded_by if self.instance else self.context["request"].user
+ )
+ if "user" in attrs:
+ if attrs["user"] == uploaded_by:
+ raise serializers.ValidationError(
+ "No puedes subir solicitudes para ti mismo."
+ )
+ if attrs["user"].job_position.rank >= uploaded_by.job_position.rank:
+ raise serializers.ValidationError(
+ "No puedes crear una solicitud para este usuario."
+ )
+ return attrs
+
+ def create(self, validated_data):
+ """Create the vacation request."""
+ # Remove the approbation fields from the validated data
+ validated_data.pop("hr_approbation", None)
+ validated_data.pop("payroll_approbation", None)
+ validated_data.pop("manager_approbation", None)
+ validated_data["uploaded_by"] = self.context["request"].user
+ vacation_request = super().create(validated_data)
+ return vacation_request
+
+ def update(self, instance, validated_data):
+ """Update the vacation request."""
+ allowed_fields = [
+ "manager_approbation",
+ "manager_approved_at",
+ "hr_approbation",
+ "hr_approved_at",
+ "payroll_approbation",
+ "payroll_approved_at",
+ "status",
+ "comment",
+ ]
+ for field, value in validated_data.items():
+ if field in allowed_fields:
+ setattr(instance, field, value)
+ instance.save()
+ return instance
diff --git a/INSIGHTSAPI/vacation/tests.py b/INSIGHTSAPI/vacation/tests.py
new file mode 100644
index 0000000..91776da
--- /dev/null
+++ b/INSIGHTSAPI/vacation/tests.py
@@ -0,0 +1,347 @@
+"""This file contains the tests for the vacation model."""
+
+from services.tests import BaseTestCase
+from rest_framework import status
+from django.contrib.auth.models import Permission
+from django.core.files.uploadedfile import SimpleUploadedFile
+from django.urls import reverse
+from django.db.models import Q
+from .factories import VacationFactory
+from .models import VacationRequest
+from .serializers import VacationRequestSerializer
+
+
+class VacationRequestModelTestCase(BaseTestCase):
+ """Test module for VacationRequest model."""
+
+ def setUp(self):
+ """Create a user and a vacation request."""
+ super().setUp()
+ self.test_user = self.create_demo_user()
+ self.user.job_position.rank = 2
+ self.user.job_position.save()
+ pdf = SimpleUploadedFile("test.pdf", b"file_content")
+ self.permission = Permission.objects.get(codename="payroll_approbation")
+ self.vacation_request = {
+ "user": self.test_user.pk,
+ "start_date": "2021-01-01",
+ "end_date": "2021-01-05",
+ "request_file": pdf,
+ }
+
+ def test_vacation_create(self):
+ """Test creating a vacation endpoint."""
+ self.vacation_request["hr_approbation"] = (
+ True # This is a check for the serializer
+ )
+ response = self.client.post(
+ reverse("vacation-list"),
+ self.vacation_request,
+ )
+ self.assertEqual(response.status_code, status.HTTP_201_CREATED, response.data)
+ self.assertEqual(response.data["hr_approbation"], None)
+
+ def test_vacation_list_user(self):
+ """Test listing all vacations endpoint for a user."""
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.create_demo_user_admin()
+ VacationRequest.objects.create(**self.vacation_request)
+ self.vacation_request["user"] = self.user
+ self.vacation_request["uploaded_by"] = self.test_user
+ VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.get(reverse("vacation-list"))
+ vacation_requests = VacationRequest.objects.filter(user=self.user)
+ serializer = VacationRequestSerializer(vacation_requests, many=True)
+ self.assertEqual(
+ response.data, serializer.data, (response.data, serializer.data)
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(len(response.data), 1)
+ self.assertEqual(response.data[0]["user"], self.user.get_full_name())
+
+ def test_vacation_list_hr(self):
+ """Test listing all vacations endpoint for HR."""
+ self.user.job_position.name = "GERENTE DE GESTION HUMANA"
+ self.user.job_position.save()
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.test_user
+ VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.get(reverse("vacation-list"))
+ vacation_requests = VacationRequest.objects.all()
+ serializer = VacationRequestSerializer(vacation_requests, many=True)
+ self.assertEqual(response.data, serializer.data)
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+ def test_vacation_list_manager(self):
+ """Test listing all vacations endpoint for a manager."""
+ self.user.job_position.rank = 5
+ self.user.job_position.save()
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ VacationRequest.objects.create(**self.vacation_request)
+ self.vacation_request["user"] = self.user
+ self.vacation_request["uploaded_by"] = self.test_user
+ VacationRequest.objects.create(**self.vacation_request)
+ # Change the area of the test user to match the user's area
+ demo_user_admin = self.create_demo_user_admin()
+ demo_user_admin.area = self.user.area
+ demo_user_admin.save()
+ demo_user_admin.job_position.rank = 1
+ demo_user_admin.job_position.save()
+ self.vacation_request["user"] = demo_user_admin
+ self.vacation_request["uploaded_by"] = self.test_user
+ VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.get(reverse("vacation-list"))
+ vacation_requests = VacationRequest.objects.filter(
+ (Q(uploaded_by=self.user) | Q(user=self.user))
+ | (
+ Q(user__job_position__rank__lt=self.user.job_position.rank)
+ & Q(user__area=self.user.area)
+ )
+ )
+ serializer = VacationRequestSerializer(vacation_requests, many=True)
+ self.assertEqual(response.data, serializer.data)
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(len(response.data), 3, response.data)
+
+ def test_vacation_retrieve(self):
+ """Test retrieving a vacation endpoint."""
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.get(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk})
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(
+ response.data["user"], self.vacation_request["user"].get_full_name()
+ )
+ self.assertEqual(
+ response.data["start_date"], self.vacation_request["start_date"]
+ )
+ self.assertEqual(response.data["end_date"], self.vacation_request["end_date"])
+
+ def test_vacation_create_invalid_dates(self):
+ """Test creating a vacation with invalid dates."""
+ self.vacation_request["start_date"] = "2021-01-06"
+ response = self.client.post(
+ reverse("vacation-list"),
+ self.vacation_request,
+ )
+ self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+ self.assertEqual(
+ response.data["non_field_errors"][0],
+ "La fecha de inicio no puede ser mayor a la fecha de fin.",
+ )
+
+ def test_vacation_create_invalid_rank(self):
+ """Test creating a vacation with invalid rank."""
+ demo_user = self.test_user
+ demo_user.job_position.rank = 8
+ demo_user.job_position.save()
+ response = self.client.post(
+ reverse("vacation-list"),
+ self.vacation_request,
+ )
+ self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+ self.assertEqual(
+ response.data["non_field_errors"][0],
+ "No puedes crear una solicitud para este usuario.",
+ )
+
+ def test_vacation_create_invalid_user(self):
+ """Test creating a vacation for the same user."""
+ self.vacation_request["user"] = self.user.pk
+ response = self.client.post(
+ reverse("vacation-list"),
+ self.vacation_request,
+ )
+ self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+ self.assertEqual(
+ response.data["non_field_errors"][0],
+ "No puedes subir solicitudes para ti mismo.",
+ response.data,
+ )
+
+ def test_vacation_owner_cancel(self):
+ """Test the owner cancelling a vacation."""
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"status": "CANCELADA"},
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK, response.data)
+ self.assertEqual(response.data["status"], "CANCELADA")
+
+ def test_vacation_owner_cancel_no_owner(self):
+ """Test the owner cancelling a vacation without being the owner."""
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.test_user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"status": "CANCELADA"},
+ )
+ self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN, response.data)
+
+ def test_vacation_manager_approve(self):
+ """Test the manager approving a vacation."""
+ self.user.job_position.rank = 5
+ self.user.job_position.save()
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"manager_approbation": True},
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK, response.data)
+ self.assertTrue(response.data["manager_approbation"])
+ vacation_object.refresh_from_db()
+ self.assertIsNotNone(vacation_object.manager_approved_at)
+
+ def test_vacation_manager_reject(self):
+ """Test the manager rejecting a vacation."""
+ self.user.job_position.rank = 5
+ self.user.job_position.save()
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"manager_approbation": False},
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK, response.data)
+ self.assertFalse(response.data["manager_approbation"])
+ self.assertEqual(response.data["status"], "RECHAZADA")
+ vacation_object.refresh_from_db()
+ self.assertIsNotNone(vacation_object.manager_approved_at)
+
+ def test_vacation_manager_approve_no_manager(self):
+ """Test the manager approving a vacation without being a manager."""
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"manager_approbation": True},
+ )
+ self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN, response.data)
+
+ def test_vacation_hr_approve(self):
+ """Test HR approving a vacation."""
+ self.user.job_position.name = "GERENTE DE GESTION HUMANA"
+ self.user.job_position.save()
+ self.vacation_request["user"] = self.test_user
+ admin = self.create_demo_user_admin()
+ self.vacation_request["uploaded_by"] = admin
+ self.vacation_request["manager_approbation"] = True
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"hr_approbation": True},
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK, response.data)
+ self.assertTrue(response.data["hr_approbation"])
+ vacation_object.refresh_from_db()
+ self.assertIsNotNone(vacation_object.hr_approved_at)
+
+ def test_vacation_hr_reject(self):
+ """Test HR rejecting a vacation."""
+ self.user.job_position.name = "GERENTE DE GESTION HUMANA"
+ self.user.job_position.save()
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ self.vacation_request["manager_approbation"] = True
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"hr_approbation": False},
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK, response.data)
+ self.assertFalse(response.data["hr_approbation"])
+ self.assertEqual(response.data["status"], "RECHAZADA")
+ vacation_object.refresh_from_db()
+ self.assertIsNotNone(vacation_object.hr_approved_at)
+
+ def test_vacation_hr_approve_before_manager(self):
+ """Test HR approving a vacation before the manager."""
+ self.user.job_position.name = "GERENTE DE GESTION HUMANA"
+ self.user.job_position.save()
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"hr_approbation": True},
+ )
+ self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN, response.data)
+
+ def test_vacation_hr_approve_no_hr(self):
+ """Test HR approving a vacation without being an HR."""
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"hr_approbation": True},
+ )
+ self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN, response.data)
+
+ def test_vacation_payroll_approve(self):
+ """Test payroll approving a vacation."""
+ self.user.user_permissions.add(self.permission)
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ self.vacation_request["hr_approbation"] = True
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"payroll_approbation": True},
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK, response.data)
+ self.assertTrue(response.data["payroll_approbation"])
+ vacation_object.refresh_from_db()
+ self.assertIsNotNone(vacation_object.payroll_approved_at)
+
+ def test_vacation_payroll_reject(self):
+ """Test payroll rejecting a vacation."""
+ self.user.user_permissions.add(self.permission)
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ self.vacation_request["hr_approbation"] = True
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"payroll_approbation": False},
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK, response.data)
+ self.assertFalse(response.data["payroll_approbation"])
+ self.assertEqual(response.data["status"], "RECHAZADA")
+ vacation_object.refresh_from_db()
+ self.assertIsNotNone(vacation_object.payroll_approved_at)
+
+ def test_vacation_payroll_approve_before_hr(self):
+ """Test payroll approving a vacation before HR."""
+ self.user.user_permissions.add(self.permission)
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"payroll_approbation": True},
+ )
+ self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN, response.data)
+
+ def test_vacation_payroll_approve_no_payroll(self):
+ """Test payroll approving a vacation without being in payroll."""
+ self.vacation_request["user"] = self.test_user
+ self.vacation_request["uploaded_by"] = self.user
+ vacation_object = VacationRequest.objects.create(**self.vacation_request)
+ response = self.client.patch(
+ reverse("vacation-detail", kwargs={"pk": vacation_object.pk}),
+ {"payroll_approbation": True},
+ )
+ self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN, response.data)
diff --git a/INSIGHTSAPI/vacation/urls.py b/INSIGHTSAPI/vacation/urls.py
new file mode 100644
index 0000000..11b4064
--- /dev/null
+++ b/INSIGHTSAPI/vacation/urls.py
@@ -0,0 +1,8 @@
+"""This file contains the URL patterns for the vacation app."""
+from rest_framework.routers import DefaultRouter
+from .views import VacationRequestViewSet
+
+router = DefaultRouter()
+router.register("", VacationRequestViewSet, basename="vacation")
+
+urlpatterns = router.urls
\ No newline at end of file
diff --git a/INSIGHTSAPI/vacation/views.py b/INSIGHTSAPI/vacation/views.py
new file mode 100644
index 0000000..104e040
--- /dev/null
+++ b/INSIGHTSAPI/vacation/views.py
@@ -0,0 +1,129 @@
+from rest_framework import status
+from django.db.models import Q
+from rest_framework import viewsets
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
+from notifications.utils import create_notification
+from django.core.mail import mail_admins
+from users.models import User
+from django.contrib.auth.models import Permission
+from .models import VacationRequest
+from .serializers import VacationRequestSerializer
+
+
+class VacationRequestViewSet(viewsets.ModelViewSet):
+ queryset = VacationRequest.objects.all()
+ serializer_class = VacationRequestSerializer
+ permission_classes = [IsAuthenticated]
+
+ def create(self, request, *args, **kwargs):
+ response = super().create(request, *args, **kwargs)
+ if response.status_code == status.HTTP_201_CREATED and response.data:
+ create_notification(
+ "Solicitud de vacaciones creada",
+ f"Se ha creado una solicitud de vacaciones a tu nombre del {response.data['start_date']} al {response.data['end_date']}.",
+ User.objects.get(pk=request.data["user"]),
+ )
+
+ return response
+
+ def list(self, request, *args, **kwargs):
+ if request.user.job_position.name == "GERENTE DE GESTION HUMANA":
+ queryset = self.queryset.all()
+ elif request.user.job_position.rank >= 5:
+ queryset = self.queryset.filter(
+ (Q(uploaded_by=request.user) | Q(user=request.user))
+ | (
+ Q(user__job_position__rank__lt=request.user.job_position.rank)
+ & Q(user__area=request.user.area)
+ )
+ )
+ elif request.user.has_perm("vacation.payroll_approbation"):
+ queryset = self.queryset.all()
+ else:
+ queryset = self.queryset.filter(
+ Q(uploaded_by=request.user) | Q(user=request.user)
+ )
+ serializer = self.serializer_class(queryset, many=True)
+ return Response(serializer.data)
+
+ def partial_update(self, request, *args, **kwargs):
+ # Check if the user is updating the hr_approbation field
+ if "manager_approbation" in request.data:
+ # Check if the user is a manager
+ if request.user.job_position.rank >= 5:
+ response = super().partial_update(request, *args, **kwargs)
+ if (
+ response.status_code == status.HTTP_200_OK
+ and response.data
+ and response.data["manager_approbation"]
+ ):
+ hr_user = User.objects.filter(
+ job_position__name="GERENTE DE GESTION HUMANA"
+ ).first()
+ if not hr_user:
+ mail_admins(
+ "No hay usuarios con el cargo de GERENTE DE GESTION HUMANA",
+ "No hay usuarios con el cargo de GERENTE DE GESTION HUMANA",
+ )
+ return response
+ create_notification(
+ "Una solicitud necesita tu aprobación",
+ f"{request.user.get_full_name()} ha aprobado la solicitud de vacaciones de {response.data['user']}. Ahora necesita tu aprobación.",
+ hr_user,
+ )
+ return response
+
+ else:
+ return Response(
+ {"detail": f"You do not have permission to perform this action."},
+ status=status.HTTP_403_FORBIDDEN,
+ )
+ elif "hr_approbation" in request.data:
+ # Check if the user is an HR and that the manager has already approved the request
+ if (
+ request.user.job_position.name == "GERENTE DE GESTION HUMANA"
+ and self.get_object().manager_approbation
+ ):
+ response = super().partial_update(request, *args, **kwargs)
+ if (
+ response.status_code == status.HTTP_200_OK
+ and response.data
+ and response.data["hr_approbation"]
+ ):
+ payroll_user = User.objects.filter(
+ user_permissions__codename="payroll_approbation"
+ ).first()
+ if not payroll_user:
+ mail_admins(
+ "No hay usuarios con el permiso de payroll_approbation",
+ "No hay usuarios con el permiso de payroll_approbation",
+ )
+ return response
+ create_notification(
+ "Una solicitud de vacaciones necesita tu aprobación",
+ f"La Gerencia de Recursos Humanos ha aprobado la solicitud de vacaciones de {response.data['user']}. Ahora necesita tu aprobación.",
+ payroll_user,
+ )
+ return response
+ else:
+ return Response(
+ {
+ "detail": f"You do not have permission to perform this action {request.user.job_position.name}."
+ },
+ status=status.HTTP_403_FORBIDDEN,
+ )
+ elif "payroll_approbation" in request.data:
+ # Check if the user is in payroll and that the HR has already approved the request
+ if (
+ request.user.has_perm("vacation.payroll_approbation")
+ and self.get_object().hr_approbation
+ ):
+ return super().partial_update(request, *args, **kwargs)
+ # Just allow the owner of the request to update the status
+ elif "status" in request.data and request.user == self.get_object().uploaded_by:
+ return super().partial_update(request, *args, **kwargs)
+ return Response(
+ {"detail": "You do not have permission to perform this action."},
+ status=status.HTTP_403_FORBIDDEN,
+ )
diff --git a/README.md b/README.md
index 84cac9b..195e25f 100644
--- a/README.md
+++ b/README.md
@@ -23,8 +23,8 @@ INSIGHTS is the intranet for C&C Services S.A.S, featuring secure login with Act
- Document management system with file upload and download capabilities
- 'About Us' page with company information and contact details
- Utility modules for enhanced productivity and collaboration
-- Job certifications and Payrolls detachments
-- Implementing a comprehensive suite of over one hundred tests to rigorously validate the functionality and performance of the application
+- Job certifications, Vacations and Payrolls detachments
+- Implementing a comprehensive suite of over 150 tests to rigorously validate the functionality and performance of the application.
## License
@@ -32,4 +32,4 @@ This project is proprietary and confidential.
Unauthorized copying, distribution, or modification of this software is strictly prohibited.
-All rights reserved. (C) CodeHive-Solutions.
+All rights reserved.
diff --git a/__tests__/login-test.jsx b/__tests__/login-test.jsx
index 6c6a6ed..0489923 100644
--- a/__tests__/login-test.jsx
+++ b/__tests__/login-test.jsx
@@ -2,7 +2,7 @@ import React from "react";
import { render, screen, fireEvent } from "@testing-library/react";
import Login from "../src/components/pages/Login";
import { createMemoryHistory } from "history";
-import { createBrowserRouter, Router } from "react-router-dom";
+import { Router } from "react-router-dom";
describe("Login component", () => {
test("renders login form with username and password fields", () => {
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..900fee7
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,223 @@
+# Welcome to the INSIGHTS project documentation!
+
+[](LICENSE)
+
+## Table of Contents
+
+- [About](#about)
+- [Technologies](#technologies)
+- [Features](#features)
+- [Usage](#usage)
+ - [Frontend](#frontend)
+ - [Building the frontend](#building-the-frontend)
+ - [File organization](#file-organization)
+ - [Code structure](#code-structure)
+ - [Potential issues](#potential-issues)
+ - [Migration](#migration)
+ - [Frontend](#frontend-1)
+- [Contributing](#contributing)
+- [License](#license)
+
+## About
+
+INSIGHTS is the intranet for C&C Services S.A.S, featuring secure login with Active Directory, a dynamic blog, document management, 'About Us,' and a unique employee birthday profile picture display. The platform also includes utility modules for enhanced productivity and collaboration.
+
+## Technologies
+
+- **Frontend**: React, Material-UI, Formik, Yup, Pnpm, Vite
+- **Backend**: Django, Django REST Framework
+- **Authentication**: JWT, Active Directory, LDAP
+- **Database**: MySQL, Redis
+- **Deployment**: Linux, Docker, Apache, Gunicorn
+
+## Features
+
+- Login and registration system with sessions and cookies
+- Dynamic blog with a storage article system
+- Secure authentication with Active Directory and LDAP
+- Data tables with CRUD operations, modularity and dinamicity
+- Connection to different APIs and services at the same time
+- User-friendly interface with Material-UI components and Formik forms
+- Vacancies and job applications management
+- Employee birthday profile picture display
+- Document management system with file upload and download capabilities
+- 'About Us' page with company information and contact details
+- Utility modules for enhanced productivity and collaboration
+- Job certifications and Payrolls detachments
+- Implementing a comprehensive suite of over one hundred tests to rigorously validate the functionality and performance of the application
+
+## Installation
+
+### Frontend:
+Pre-requisites:
+- Git
+- Node.js
+- Pnpm
+
+1. Clone the project repository `git clone https://github.com/CodeHive-Solutions/INSIGHTS.git`
+2. Go to the project directory `cd INSIGHTS`
+3. Install the dependencies by running `pnpm install` (assuming you have pnpm installed)
+
+
+## Usage
+
+### Frontend:
+Pre-requisites:
+- Access to the server where the project is hosted
+
+1. Access the server via SSH
+2. Go to the project directory `cd /var/www/INSIGHTS`
+3. Run the following command to start the frontend server: `pnpm run dev`
+4. The frontend server will start running on port 8000 that is to say, you can access the frontend by going to `http://server_ip:8000`
+5. The frontend server will automatically update when changes are made to the code
+6. To stop the frontend server, press `Ctrl + C`
+
+#### Building the frontend:
+1. Access the server via SSH
+2. Go to the project directory `cd /var/www/INSIGHTS`
+3. Run the following command to build the frontend: `pnpm run build && pnpm run postbuild`
+4. The files will be built in the `/dist` directory
+5. Move the `/dist` directory to the server where the frontend will be hosted
+6. The frontend can be served by any web server (e.g. Apache, Nginx)
+
+> Note: The login and other functionalities will not work if the backend is not running, also have in mind that the frontend will point to the development backend server by default unless the frontend URL where is hosted is exactly: `https://intranet.cyc-bpo.com`, this can be change in the `src/assets/getApi.js` file
+
+#### File organization:
+- The frontend code is located in the `/src` directory
+- The main entry point is the `main.js` file
+- The `/images` directory is organized based on the pages where the images are used
+- The components are located in the `/src/components` directory
+- The `/components` directory is organized as follows:
+ - `/common`: Contains common components used throughout the application
+ - `/container`: Contains the main container components
+ - `/pages`: Contains the main pages of the application
+ - `/shared`: Contains shared components used in multiple pages
+
+#### Code structure:
+- The code in each component is organized into sections (e.g. imports, javascript functions, another JSX elements part of the main component and the main component return statement)
+
+Example of a component code structure with a shopping cart component:
+
+```javascript
+// Import statements
+import React, { useState } from 'react';
+import PropTypes from 'prop-types';
+
+// Helper functions
+const calculateTotal = (items) => {
+ return items.reduce((acc, item) => acc + item.price, 0);
+};
+
+// Main component function
+const ShoppingCart = ({ initialItems }) => {
+ // State hooks
+ const [items, setItems] = useState(initialItems);
+
+ // Event handlers
+ const addItem = (item) => {
+ setItems([...items, item]);
+ };
+
+ const removeItem = (index) => {
+ setItems(items.filter((_, i) => i !== index));
+ };
+
+ // JSX elements part of the main component
+ const renderItems = () => {
+ return items.map((item, index) => (
+