dfucci / emoide23

Emotionally-Aware IDE

Welcome to the Emotionally-Aware IDE GitHub repository! This plugin is designed to increase productivity and quality in software development by leveraging developers' emotions to enhance their work. By integrating affective computing and biometric data analysis into the IDE, developers can receive valuable insights into their emotional states, enabling them to make informed decisions regarding code quality, productivity, and well-being.

Documentation

For a more comprehensive understanding of this tool, you can refer to the user and technical manual located in the source code. The manual is available on the project's website within the file documentation.html It provides detailed information and instructions to help you explore the tool's features and functionalities.

Purpose

The purpose of this tool is to develop an emotionally-aware IDE plugin that empowers developers to improve their software development process. The key objectives of this tool include:

• Emotion Monitoring
• Emotional Feedback
• Code Qualtiy Suggestions
• Work break recommendations
• Flow State Preservation
• Integration with Visual Studio Code (IDE)

Requirements

Before running this tool to its full extent, make sure you meet the following necessary requirements:

1. Python Server: Install the necessary requirements for the Python server. Refer to the Getting Started section for detailed instructions.
2. Gazepoint Control: The Gazepoint Control provided by Gazepoint must be active during a session to record data from the eye tracker. Calibrating the eye tracker is recommended to enhance gaze accuracy.
3. E4 Streaming Service: The E4 Streaming Service provided by Empatica must be active and connected during a session to record data from the wristband.
4. EEG Launcher: The EEG Launcher provided by Emotiv must be active and connected during a session to record data from the EEG device.

4.Open visual studio code and go to Edit>Open folder>EmoIDE_project>Extension

5.run(f5) extension.js with the vscode developer enviroment selected

Getting Started

To get started with the Emotionally-Aware IDE Plugin, follow these steps:

1. Install the necessary Python modules: Open the command prompt or terminal. Install the required Python modules by running the following command:

pip install -r Requirements.txt

Note: Ensure that Python is installed on your system before proceeding with the installation of the modules.

2. Start the server: After installing the required modules, you can start the server. Open the command prompt or terminal and then run the following command to start the server:

python main.py

Note: This will initiate the server, enabling it to listen for extension connection

3. Start the extension: Follow these steps to integrate and utilize the plugin within Visual Studio Code (IDE):

• Navigate to the extension folder using the following command:

cd Extension

Note: You need to be in the source code root directory.

• Open the extension path in Visual Studio Code using the following command:

code .

• Run the extension.js using the (f5) key with the VSCode developer environment selected.

4. Start using the product:

• Once the server is up and running and the extension is running and connected to the server, you can start utilizing the Emotionally-Aware IDE Plugin.
• Feel free to explore the various functionalities, settings, and features offered by the product.

We hope that this tool significantly improves your software development process by incorporating emotions as a valuable asset. Should you encounter any issues, have suggestions please don't hesitate to create an issue or pull request on this repository. Happy coding!