Skip to content

Latest commit

 

History

History
128 lines (82 loc) · 4.92 KB

README.md

File metadata and controls

128 lines (82 loc) · 4.92 KB
Raw

CSHR (Codescalers HR Management System)

A comprehensive management system that provides a range of services, including the ability to submit vacation requests. This system seamlessly integrates with a global calendar, allowing users across all offices to view approved vacations collectively. Additionally, the calendar showcases Birthdates, Events, Meetings, and Holidays, offering a centralized and accessible overview for all users within the organization.

Core Objectives

  1. Global Overview:

    • Display a centralized calendar featuring approved vacations, holidays, events, meetings, and birthdays.
    • Search for users, view their public information, and identify their office affiliation.
    • Search for specific skillsets and identify users with those skills.

  2. Local Management:

    • Appoint an admin for each location.
    • Restrict admin rights to the respective location without sharing across different locations.

Access Levels

  • User: Any individual affiliated with the organization.
  • Supervisor: Each user has a designated supervisor.
  • Admin: Location-specific administrators with defined responsibilities.

Key Features

  • Global Calendar: Track approved vacations and key events.
  • Vacation Requests: Users can apply for vacations.
  • Approval/Denial Process: Admins can manage and approve/deny vacation requests.
  • Document Requests: Users can request documents from HR.
  • Evaluation Reminders: Receive reminders for various evaluations.
  • Reporting: Automatically generate comprehensive reports on-demand.

Development Tools

Various tools are available for development:

  • Terraform Script: Deploy two machines in the Threefold grid for frontend/backend. Refer to the script in ./terraform.
  • Testing Site Deployment: Execute make deploy to deploy and make destroy to destroy the testing site.
  • Poetry environment: After pressing make install Poetry will be installed. However, to complete the setup, it's crucial to add the Poetry executable to the system's PATH by running the command export PATH="/root/.local/bin:$PATH"

Development Mode Commands

When in development mode, use the following Makefile commands:

  • make migrate: Apply migration and migrate.
  • make user: Create a superuser.
  • make runserver: Run the server.
  • make lint: Perform linting on both server and client.
  • make install: Install dependencies in both client and server.
  • make data: Create dummy data for testing e.g., users/offices.

Implementation Details

  • Client: Developed using Svelte. Note that the UI will transition to Vue3 in the future.
  • Server: Implemented using Django.
  • Notification Service: Requires a running Redis server for notification functionality.

Installation Process

To facilitate the installation process, this project utilizes the poetry package manager for Python and pnpm for Node.js. Follow the steps outlined below for a seamless installation:

  1. Install Poetry: Execute the following command to install Poetry for Python:
curl -sSL https://install.python-poetry.org | python3 -
  1. Install Pnpm: To install pnpm globally for Node.js, run the following command:
npm i -g pnpm

After installing these packages you can now install the required packages by executing: 3. Install project Packages

make install

By following these steps, you ensure the proper setup of the required package managers for this project.

Project Configuration

After executing

make install && make migrate

Please refer to .env.template for all required values. Ensure all values are populated in the .env file within the config directory.

Runing the project using Docker and Docker Compose

To run the full project with all instances, follow these steps:

  1. Set Environment Variables

Create a .env file beside the config directory and set the necessary environment variables. Refer to the previous section for sample environment variable configurations.

  1. Execute Docker Compose

Run the following command to start the Docker containers and please make sure that you are on the root of the project:

# --> To run all services

└─(✹)──> docker compose -f ./docker/docker-compose.yml --env-file=./config/.env up --build -d 

# --> To stop all services
└─(✹)──> docker compose -f ./docker/docker-compose.yml --env-file=./config/.env down

Also, you can excute the command using Make:

  • make docker-up To run all services
  • make docker-down To stop all services

After executing the command, you should see a confirmation similar to the following:

  1. Verify Successful Deployment

This indicates that the Docker containers are being created and the services are starting up.

  • docker-compose-deployments

You can also take a look at configuration.md