innovaDigits - Performance Management System

A performance management system to track your employees performance

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

What is innovaDigits-PMS ?

At first, let's understand what PMS is. PMS is the abbreviation for Performance Management System, which is used to align employees' individual goals and performance with the overall objectives of the company.

It encompasses processes, tools, and activities aimed at ensuring that employees work towards achieving the organization's strategic goals, thereby contributing to the company's success.

The backend we build is for modules that will be part of a bigger PMS that will be developed by one of the biggest software house companies in Egypt which is innovaDigits.

You can find more info about the project from here.

Our Project Is divided into three core modules

• User and teams
• Competencies
• FeedBack

Note:

• To use the Feedback or Competency modules, API calls need to be made in the Users and Teams modules.
• Details regarding these API calls can be found in the API Endpoints section.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Getting Started

This project utilizes Node.js and npm as its package manager. To run this project successfully, ensure that you have Node.js installed on your machine. Once Node.js is installed, execute the following command:

npm install

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

* npm

```sh
npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com

2. Clone the repo

git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

npm install

4. Enter your API in config.js

const API_KEY = 'ENTER YOUR API';

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• **** - ** - - **
• **** - ** - - **

Acknowledgements