https://github.com/anonymerniklasistanonym/unistats

Visualize your current university progress (written from a Computer Science student at the university of Stuttgart)
https://github.com/anonymerniklasistanonym/unistats

javascript no-dependencies nodejs offline typescript university visualization

Last synced: 29 days ago
JSON representation

Visualize your current university progress (written from a Computer Science student at the university of Stuttgart)

• Host: GitHub
• URL: https://github.com/anonymerniklasistanonym/unistats
• Owner: AnonymerNiklasistanonym
• License: gpl-3.0
• Created: 2019-03-29T21:51:04.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-10-07T17:52:18.000Z (over 1 year ago)
• Last Synced: 2024-11-05T11:35:46.243Z (3 months ago)
• Topics: javascript, no-dependencies, nodejs, offline, typescript, university, visualization
• Language: TypeScript
• Homepage: https://anonymerniklasistanonym.github.io/UniStats/
• Size: 556 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# UniStats

Visualize your current progress at University.

Made from a Computer Science student of the University of Stuttgart (could be incompatible with your university).

Any problems/ideas? - open an issue and I try my best.

*This is just a hobby project of mine and in no way battle tested etc.!*

## Setup

1. Install [NodeJs](https://nodejs.org/en/download/current/)

2. Install dependencies (only necessary for building/compiling not for running)

   ```sh

   npm install

   ```

3. Build program

   ```sh

   npm run build

   ```

4. Run program using either the file [`data/demo.json`](data/demo.json) or if provided a custom file `data/uni.json` as input

   ```sh

   npm run start

   ```

## Other scripts

| Commands | Description |

| ---------------- | ---------------- |

| `npm run start:live` | Run `npm run start` automatically every time a JSON input file is updated |

| `npm run docs` | Create the documentation of the source code |

| `npm run lint:fix` | Lint the source code and automatically fix some errors |

### Update JSON schema

```sh

npm run createJsonSchema

```