https://github.com/alemoraru/exceed-project-validation
EXCEED Project Validation
https://github.com/alemoraru/exceed-project-validation
css educational-project error-messages llm-inference ollama reactjs tailwindcss typescript vitejs
Last synced: 28 days ago
JSON representation
EXCEED Project Validation
- Host: GitHub
- URL: https://github.com/alemoraru/exceed-project-validation
- Owner: alemoraru
- License: mit
- Created: 2025-08-05T08:09:14.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-08-31T12:04:24.000Z (8 months ago)
- Last Synced: 2025-08-31T14:19:34.875Z (8 months ago)
- Topics: css, educational-project, error-messages, llm-inference, ollama, reactjs, tailwindcss, typescript, vitejs
- Language: TypeScript
- Homepage:
- Size: 464 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EXCEED Project Validation
This repository is designed for evaluating the effectiveness of prompt templates and language models in rephrasing error
messages for buggy code snippets. The web application allows users to select different models and prompt styles,
generate improved error messages, and provide feedback on their quality. All feedback is stored locally and can be
exported for further analysis.
---
## 🛠️ Requirements
- [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed
- [Ollama](https://ollama.com/) installed and running locally
- Download the desired Ollama models on your machine before using the app (models must be available locally). More
specifically, the following models are used for validation and need to be downloaded:
- [`llama3.1:8b`](https://ollama.com/library/llama3.1:8b)
- [`qwen2.5:7b`](https://ollama.com/library/qwen2.5:7b)
- [`qwen2.5-coder:7b`](https://ollama.com/library/qwen2.5-coder:7b)
- [`granite3.3:8b`](https://ollama.com/library/granite3.3:8b)
> **Note**: Technically, any Ollama model can be used, but the ones above are specifically valid options on the
> frontend. If you want to use a different model, you can change the `ollamaModel` in the `src/data/codeSnippets.ts`
> file to match the model you have available locally.
---
## ⚡ QuickStart
1. **Clone the repository:**
```sh
git clone git@github.com:alemoraru/exceed-project-validation.git
cd exceed-project-validation
```
2. **Install dependencies:**
```sh
npm install
```
3. **Start the development server:**
```sh
npm run dev
```
The app will be available at [http://localhost:8080](http://localhost:8080).
---
## 🚀 Usage
- Open the app in your browser at [http://localhost:8080](http://localhost:8080).
- Select a code snippet and choose a model and error message style.
- Click "Improve Error" to generate a rephrased error message using the selected model and prompt.
- Review the improved error message and submit feedback using the feedback form.
- Download all feedback as a CSV file for further analysis (it's stored locally in the browser's localstorage).
---
## 🧩 Tech Stack
- [Vite](https://vitejs.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- [React](https://reactjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Ollama](https://ollama.com/)
---
## 🤝 Contributing
This project was developed as part of the EXCEED MSc Thesis project at Technische Universiteit Delft. As such,
contributions of any sort will not be accepted. This repository is provided for replication and educational purposes
ONLY. Since it was used as a validation step, before deploying our study on Prolific, it is NOT intended for further
development or contributions.
---
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.