Employee Tracker

Description

This is a command-line application built in TypeScript to manage a company's employee database. It utilizes PostgreSQL as the database management system and provides functionality to manage departments, roles, and employees. The application allows users to:

• View all departments, roles, and employees.
• Add new departments, roles, and employees.
• Update employee roles and managers.
• View employees by manager and department.
• View the total utilized budget for each department.

The application adheres to a normalized relational database schema for managing the data efficiently.

---

Table of Contents

• Features
• Installation
• Usage
• Schema Design
• Walkthrough Video
• Project Structure
• Technologies Used
• Contributing
• License

---

Features

• Core Functionality:

  • View all departments, roles, employees, and managers.
  • Add a new department, role, employee, or manager.
  • Update existing records, such as:
    • Department names
    • Role titles and salaries
    • Employee details (name, role, manager)
    • Manager details
  • Delete departments, roles, employees, and managers.

• Bonus Features:

  • Update employee managers.
  • View employees by manager or department.
  • View the total utilized budget of a department.

---

Installation

Prerequisites

Ensure you have the following installed:

• Node.js
• PostgreSQL
• TypeScript globally installed (npm install -g typescript)

Steps

1. Clone the repository:

   git clone https://github.com/Azugr/Module-10-Challenge
   cd Main

2. Install dependencies:

   npm install

3. Set up the database:

   • Open your PostgreSQL client and run the db/schema.sql file to create the database and tables:

     psql -U <username> -f db/schema.sql

   • Populate the database with initial data using db/seeds.sql:

     psql -U <username> -f db/seeds.sql

4. Configure environment variables:

   • Important: Do not share your .env file! Instead, use the .env.EXAMPLE file included in the repository.
   • Rename .env.EXAMPLE to .env and update the following placeholders:

     DB_USER=<your_db_user>
     DB_PASSWORD=<your_db_password>
     DB_HOST=localhost
     DB_PORT=5432
     DB_NAME=employees_db

5. Compile TypeScript to JavaScript:

   npx tsc

6. Start the application:

   node dist/server.js

---

Usage

1. Start the application:

   node dist/server.js

2. Navigate through the menus:

   • Select actions such as viewing, adding, updating, or deleting departments, roles, and employees.
   • View hierarchical data such as employees by manager or department.

3. Use Ctrl+C to exit the application.

---

Schema Design

The database schema is structured as follows:

(Replace with the correct path if necessary)

Tables:

1. department

   • id: Primary key (unique identifier for departments).
   • name: Unique name for the department (e.g., IT, HR).

2. role

   • id: Primary key (unique identifier for roles).
   • title: Unique name for the role (e.g., Software Engineer).
   • salary: Salary associated with the role.
   • department: Foreign key referencing the department table.

3. employee

   • id: Primary key (unique identifier for employees).
   • first_name: Employee's first name.
   • last_name: Employee's last name.
   • role_id: Foreign key referencing the role table.
   • manager_id: Self-referential foreign key for hierarchical relationships (e.g., an employee's manager).

---

Walkthrough Video

Watch the walkthrough video here https://drive.google.com/file/d/1fjCoMvP4aCageSa1rA8XFUDQzHrT5rLk/view?usp=sharing

---

Project Structure

Main/
├── assets/
│   ├── image.png         # Database schema diagram
├── main/
│   ├── db/
│   │   ├── queries.sql    # Additional SQL queries
│   │   ├── schema.sql     # Database schema
│   │   ├── seed.sql       # Initial seed data
│   │   ├── tables.sql     # Table creation scripts
│   ├── dist/
│   │   ├── connection.js  # Compiled database connection logic
│   │   ├── db.js          # Compiled database methods
│   │   ├── index.js       # Compiled application entry point
│   │   ├── server.js      # Compiled server logic
├── src/
│   ├── types/             # TypeScript type definitions
│   ├── connection.ts      # Database connection file
│   ├── db.ts              # Database methods
│   ├── index.ts           # Main application logic (TypeScript)
├── .env                   # Environment variables
├── .env.EXAMPLE           # Environment variable template
├── package.json           # Node.js dependencies
├── package-lock.json      # Lockfile for npm dependencies
├── tsconfig.json          # TypeScript configuration
├── .gitignore             # Git ignore file
├── LICENSE                # License information
├── README.md              # Project documentation

---

Technologies Used

• Node.js: JavaScript runtime.
• TypeScript: Static typing for JavaScript.
• PostgreSQL: Relational database management system.
• Inquirer.js: Command-line user interface for managing interactions.

---

Contributing

Feel free to contribute to this project by submitting issues or pull requests. Please ensure your code adheres to the existing coding style.

---

License

This project is licensed under the MIT License.