The Employee Management Portal is a web application designed to facilitate the management of company employees. It provides a user-friendly interface for viewing, adding, editing, and deleting employee records.
You can find the project planning and roadmap on GitHub Project or GitHub Issues
The Employee Management Portal provides the following features:
Display a List of Employees: The portal allows users to view a list of all employees. Each employee is represented by their profile information, including their ID, first name, last name, email, and job title.
View Individual Employee Profile: Users can access the detailed profile of each employee by selecting them from the list. This profile displays the employee's ID, first name, last name, email, and job title.
Add an Employee: Users can add a new employee to the portal by providing their ID, first name, last name, email, and job title. Once added, the employee will appear in the list of employees.
Delete an Employee: Users have the ability to delete an employee from the portal. When an employee is deleted, their profile and information will be removed from the system.
Modify an Employee: Users can update the details of an existing employee. They can edit the employee's first name
Each employee in the Employee Management Portal has a profile that contains the following information:
ID: The unique identifier for the employee.First Name: The first name of the employee.Last Name: The last name of the employee.Email: The email address of the employee.Job Title: The job title or position of the employee.
The Employee Management Portal is built using the following technologies:
- 💻 React.js - A JavaScript library for building user interfaces.
- 🎨 Tailwind CSS - A utility-first CSS framework for rapid UI development.
- 📈 Redux - A predictable state container for managing app state.
- ✔️ Jest - A JavaScript testing framework for unit testing.
- ✅ Testing Library - A suite of libraries for component integration testing.
- 🧶 Yarn - A fast and reliable package manager.
- ✨ Node.js - A JavaScript runtime environment.
- 💅 Prettier - A code formatter to maintain consistent code style.
- 🚨 ESLint - A pluggable linting utility for identifying and reporting code errors and - inconsistencies.
- ⚓ TypeScript - A typed superset of JavaScript for enhanced development.
- ⚓ Husky - A Git hook manager to enforce pre-commit hooks.
GitHub Actions - A CI/CD platform for automating workflows.
- 🐳 Docker - A containerization platform for running applications in isolated environments.
System Requirements: Make sure you have docker installed In case you do not have it installed or do not want to build the project with the init.sh script, it is recommended to install all the dependencies included in the dockerfile of this project. Node JS 18, Yarn latest version
To set up the Employee Management Portal on your local machine, follow these steps:
Make sure that they have permissions to execute init.sh: sudo chmod -R u=rxw,go=rx tests sudo chmod u=rxw,go=rx init.sh
- Run
./init.sh - Run
yarn install
To run the Employee Management Portal on your local machine, follow these steps:
- Run
yarn start
To run the Employee Management Portal on your local machine, follow these steps:
- Lint:
yarn lint - Tests:
yarn test - Coverage:
yarn test:coverage - Typing:
yarn type:checks - Format code:
yarn prettier
If you're interested in more of my projects, contributions, and activities, feel free to visit my GitHub profile.
If you'd like to learn more about my professional background and experience, feel free to connect with me on LinkedIn. On my LinkedIn profile, you can find more information about my skills, work history, and education.