Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anonymerniklasistanonym/universitycourseprogressupdater
Updates a README.md file on execution with a visualization of the latest progress state
https://github.com/anonymerniklasistanonym/universitycourseprogressupdater
javascript no-dependencies nodejs offline typescript visualization
Last synced: about 4 hours ago
JSON representation
Updates a README.md file on execution with a visualization of the latest progress state
- Host: GitHub
- URL: https://github.com/anonymerniklasistanonym/universitycourseprogressupdater
- Owner: AnonymerNiklasistanonym
- License: mit
- Created: 2020-04-25T16:45:48.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-07T17:38:00.000Z (about 1 year ago)
- Last Synced: 2024-04-16T19:10:12.285Z (7 months ago)
- Topics: javascript, no-dependencies, nodejs, offline, typescript, visualization
- Language: TypeScript
- Homepage: https://anonymerniklasistanonym.github.io/UniversityCourseProgressUpdater/
- Size: 713 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UniversityCourseProgressUpdater
Updates a `README.md` file on execution with a visualization of the latest progress state.
- 100% NodeJs without any dependencies
- 1 executable JavaScript file
- 1 JSON data file with 1 JSON schema file (optional but recommended)
## How to use
Prerequisites:
1. Have `nodejs` installed and install all dev dependencies (not necessary afterwards)
```sh
npm install
```
2. Create `updateProgress.mjs` (and optionally `progress.schema.json`)
```sh
# Create dist/updateProgress.mjs
npm run build
npm run createBundle
# Optionally create progress.schema.json
npm run createJsonSchema
```
3. Create for example the following file structure:
```text
repo
|_ README.md
|_ progress
|_ progress.json
|_ progress.schema.json
|_ updateProgress.mjs
```
Insert in the `README.md` a begin/end comment somewhere:
[//]: # (Markdown content README.md begin)
```markdown
....
# Progress title
[//]: # (Progress EXAMPLE_ID begin)
| Points >= 50% | Passed Exercises >= 4 |
| --- | --- |
| 75%/50% :heavy_check_mark: | 1/4 :x: |
| Exercise | Points | Notes |
| --- | --- | --- |
| [1](ex01) (2020.10.06) | 12.5/15 (*theoretical*) + 10/15 (*programming*) = [22.5/30](ex01/feedback.pdf) (75%) | |
[//]: # (Progress EXAMPLE_ID end)
...
```
[//]: # (Markdown content README.md end)
An example `progress.json`: (you can check the [`examples`](./examples/) directory for more examples)
[//]: # (Markdown content progress.json begin)
```json
{
"$schema": "./progress.schema.json",
"exercises": [
{
"directory": "ex01",
"feedbackFile": "feedback.pdf",
"name": 1,
"submission": [
{
"achievedPoints": 12.5,
"name": "theoretical",
"points": 15
},
{
"achievedPoints": 10,
"name": "programming",
"points": 15
}
],
"submissionDate": "2020-10-05T22:00:00.000Z"
}
],
"name": "Course Example 02 SS20",
"progressName": "EXAMPLE_ID",
"requirements": {
"minimumPointsPercentage": {
"allSubmissions": 0.5
},
"minimumPassedExercises": {
"number": 4
}
},
"version": 5
}
```
[//]: # (Markdown content progress.json end)
4. Run the program without any other dependencies:
[//]: # (Markdown content run updateProgress.mjs begin)
```sh
node ./progress/updateProgress.mjs PROGRESS_JSON=progress/progress.json
```
[//]: # (Markdown content run updateProgress.mjs end)
## Development
- Lint (and automatically fix) most errors: `npm run lint:fix`
- Run tests: `npm test`
- Run examples: `npm run runExamples`
- Debug code using the examples in [VSCode](https://code.visualstudio.com/): Open the repository as working directory and click `Ctrl` + `Shift` + `D`
## Timezones
If you use the date property and want to change the timezone (because it is executed on a server somewhere else or something do the following):
Add `TZ='XYZ'` before running `node` to set the timezone for the process.
Possible values are for example:
- `UTC` (UTC+00:00)
- `Europe/Amsterdam` (UTC+05:00 / DST mixes this up)
- `Europe/Berlin` (UTC+01:00 / DST mixes this up)
- `America/Washington` (UTC−08:00 / DST mixes this up)
Example for `America/Washington`:
```sh
TZ='America/Washington' node ./progress/updateProgress.mjs
```
## TODO
- [x] Add examples
- [ ] More/Better examples
- [ ] Automate example generation and README content so it's never wrong or outdated
- [ ] Add tests to verify its actually correct
- [ ] More test coverage (80% would be nice)
- [ ] Add more options
- [x] Option for minimum points/percentage of points per submission
- [x] Option for multiple subtasks of a single exercise
- [x] Option to declare exercise as not submitted
- [ ] Add predictions (very complex but would be cool)
- [ ] Add more requirements and validate the existing ones