Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributing to EclipseEvents

We welcome contributions to EclipseEvents! By participating in this project, you agree to follow the guidelines and best practices outlined below. Whether you're fixing bugs, adding new features, or improving documentation, your contributions are highly appreciated.

## How to Get Started

1. **Fork the Repository**
First, fork the repository to your own GitHub account by clicking the "Fork" button at the top-right of the page.

2. **Clone Your Fork**
Clone your forked repository to your local machine:
```bash
git clone https://github.com/your-username/EclipseEvents.git
81 changes: 53 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,55 @@
# EclipseEvents
[![License](https://img.shields.io/badge/License-AGPL--3.0--or--later-blue.svg)](https://github.com/ArgLab/EclipseEvents/blob/main/LICENSE.md)
# EclipseEvents
Real-Time Plugin for Eclipse Event Tracking.


## Environment Setup for plugin Project

Step 1: We have to install the PDE (Plugin Development environment) in order to create plugins for eclipse.

Open eclipse IDE

Got to Help -> install New Software -> select "The Eclipse Project Updates"

This will pop up a list of softwares, select -> "Eclipse Plugin Development Tools" proceed with the license terms and click "Finish"

Step2: Project Run

* setup jdk 17 in your eclipse
* Clone the project
* Open MANIFEST.MF
* Ensure your dependencies has the following plugins
* org.eclipse.ui
* org.eclipse.core.runtime
* org.eclipse.ui.console
* org.eclipse.jface.text
* Ensure in your extensions tab has following plugins
* org.eclipse.commands
* org.eclipse.ui.handlers
* org.eclipse.ui.bindings
* org.eclipse.ui.menus
A real-time plugin for tracking events within the Eclipse IDE.

---

## 🚀 Features
- Real-time event tracking for student coding behaviors.
- Captures key actions like keystrokes, file changes, debugging, and tool usage.
- Extensible and designed for scalability in educational and research settings.

---

## 🔧 Environment Setup

### **Step 1: Install Plugin Development Environment (PDE)**
To create and run Eclipse plugins, you need to install the PDE in your Eclipse IDE.

1. Open Eclipse IDE.
2. Navigate to `Help -> Install New Software`.
3. In the dropdown, select **The Eclipse Project Updates** repository.
4. From the list, select **Eclipse Plugin Development Tools**.
5. Proceed with the license agreement and click **Finish**.

---

### **Step 2: Setup Project**
#### **Requirements**
- **Java Version**: Java 17 or higher.
- **Dependencies**: Ensure the following plugins are added to your project (add them if missing):
- **Required Dependencies**:
- `org.eclipse.ui`
- `org.eclipse.core.runtime`
- `org.eclipse.ui.console`
- `org.eclipse.jface.text`
- **Required Extensions**:
- `org.eclipse.commands`
- `org.eclipse.ui.handlers`
- `org.eclipse.ui.bindings`
- `org.eclipse.ui.menus`

#### **Steps to Run the Project**
1. Clone the repository:
```bash
git clone https://github.com/ArgLab/EclipseEvents.git
```
2. Open the project in Eclipse IDE.
3. Configure the project:
- Open `MANIFEST.MF` in the project.
- Verify and add any missing dependencies or extensions from the lists above.
4. Set up your runtime environment:
- Go to `Run Configurations`.
- Select Eclipse Application as the runtime configuration.
5. Run the project! 🎉
Binary file added eclipse-monitor-update-site/artifacts.jar
Binary file not shown.
Binary file added eclipse-monitor-update-site/content.jar
Binary file not shown.
Binary file not shown.
Binary file not shown.
6 changes: 6 additions & 0 deletions eclipse-monitor-update-site/site.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<site>
<feature url="features/TestPluginProject_1.0.1.jar" id="TestPluginProject" version="1.0.1"/>
<!-- <feature url="features/TestPluginProject_1.0.2.jar" id="TestPluginProject" version="1.0.2"/> -->

</site>