Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brookr/gradiator
Code Fellows grading, assisted by AI
https://github.com/brookr/gradiator
Last synced: 4 days ago
JSON representation
Code Fellows grading, assisted by AI
- Host: GitHub
- URL: https://github.com/brookr/gradiator
- Owner: brookr
- License: other
- Created: 2024-06-12T06:56:33.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-12T07:02:13.000Z (5 months ago)
- Last Synced: 2024-06-12T12:18:26.374Z (5 months ago)
- Language: HTML
- Size: 322 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gradiator 🚀
Gradiator is a demo example application experiments with AI grading, via a Chrome extension using Next.js.
## Table of Contents ✨
- [Description](#description)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
# Description
AI, tuned with the right prompts, can provide detailed and valuable feedback on student work.
This sidebar is designed to give TAs suggestions on what aspects of submissions need the most attention. Example feedback is also provided.
# Installation
To install and run Gradiator as a Chrome Sidebar locally, follow these steps:
1. Clone this repository
2. Navigate to project directory
3. Navigate to project directory
4. Install the dependencies using npm
# Usage
## Run Locally 🔥
To run Gradiator locally, follow these steps:
Run the project:
```
npm run dev
```
This will run project at localhost:
`http://localhost:3000/`
## Build and Import To Chrome 🔥
To build and import Next.js Chrome Extension Starter to chrome browser, follow these steps:
1. Build the project:
```
npm run build
```
> This will run prep and export to create new folder 'out/', and rename '_next' forlder to 'next' (without underscore)
2. Open Google Chrome and go to chrome://extensions.
3. Enable the "Developer mode" toggle switch.
4. Click on "Load unpacked" and select the out folder generated by the build process.
5. Gradiator should now be loaded as an unpacked extension in Google Chrome.
# Contributing
Contributions to Gradiator are welcome! If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.
# License
This project is licensed under the MIT License.
Feel free to customize and modify it based on your specific requirements.
Make sure to include any additional information, such as troubleshooting tips or specific
Chrome extension functionality, to provide a comprehensive guide for users.
```
MIT License
Copyright (c) 2023 Justinas Kairys (ibnzUk.eth)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```