Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codam-coding-college/peerpp-bot
The peer++ evaluation system ensures quality evaluations by matching students with high-level evaluators
https://github.com/codam-coding-college/peerpp-bot
42born2code codam flask slack-bot webhooks
Last synced: 3 days ago
JSON representation
The peer++ evaluation system ensures quality evaluations by matching students with high-level evaluators
- Host: GitHub
- URL: https://github.com/codam-coding-college/peerpp-bot
- Owner: codam-coding-college
- Created: 2022-03-29T13:57:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-07T12:45:42.000Z (over 1 year ago)
- Last Synced: 2023-06-07T13:37:45.327Z (over 1 year ago)
- Topics: 42born2code, codam, flask, slack-bot, webhooks
- Language: TypeScript
- Homepage:
- Size: 567 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## What is the Peer++ system?
The peer++ evaluation system ensures quality evaluations by matching students with high-level evaluators.
Read more about it [here](https://codam.notion.site/Peer-Evaluations-810cdd6714074f1b881fc8d4e54e5e5f).
---
## Installation
Convert `./config/env-example` to `.env` and fill in the secret data.
By default port `8080` is used for the webhooks express server
and port `3000` is used for the slack bot using the slackbot API.
The slackbot runs over Websockets instead of HTTP Requests.
### Development
1. Install NodeJS 18.x or higher.
2. Install dependencies: `npm install`
3. Use `npm run dev` for development mode.
### Production
In production environments, use Docker.
- Use `make up` to run in a docker container.
- Use `make down` to shut down the docker container.
Or, if you're confident in your Docker skills, you can just use the `docker compose` command directly.
#### Logrotate
In production, we recommend setting up a logrotate in the `logs` directory.
Create a logrotate config in the `/etc/logrotate.d` folder.
You can use or modify the configuration below:
```
/root/peer-bot/logs/log.txt {
weekly
missingok
rotate 4
compress
delaycompress
shred
ifempty
create 644 root root
}
```
---
## Useful how-tos
### Add a user to the peer++ group
1. Go to the `peer-bot` directory.
2. Run `node src/scripts/manageUser.js add ` where `` is the login of the user you want to add to the peer++ group.
### Remove a user from the peer++ group
1. Go to the `peer-bot` directory.
2. Run `node src/scripts/manageUser.js remove ` where `` is the login of the user you want to remove from the peer++ group.
### List all users in the peer++ group
1. Go to the `peer-bot` directory.
2. Run `node src/scripts/getUsers.js`.
### Manually schedule a peer++ evaluation
1. Go to the `peer-bot` directory.
2. Run `node src/scripts/bookEval.js ` where `` is the scaleID of the scale you want to use for the evaluation, `` is the teamID of the team you want to schedule an evaluation for and `` is the userID of the evaluator (the one evaluating the team).
### Allow cancellation of a peer++ evaluation
1. Go to the `peer-bot` directory.
2. Run `sqlite3 db/peerdb.sqlite`.
3. Run `INSERT INTO expiredTeam(teamID) VALUES ('');` in the sqlite3 shell, where `` is the teamID of the team you want to cancel the evaluation for.
4. Run `.exit` to exit the sqlite3 shell.
5. Tell the team that they can now cancel the evaluation (make them press x next to the evaluation on the Intranet).
6. Run `node src/scripts/addPoint.js ` where `` is the login of the student who lost an evaluation point for the cancellation. This will refund the point to the student.