https://github.com/metakgp/kronos
A webapp to serve past year grade distributions of IIT KGP students, for IIT KGP students
https://github.com/metakgp/kronos
gradekeeper-iitkgp grades-iitkgp kronos kronos2 metakgp
Last synced: 3 months ago
JSON representation
A webapp to serve past year grade distributions of IIT KGP students, for IIT KGP students
- Host: GitHub
- URL: https://github.com/metakgp/kronos
- Owner: metakgp
- License: agpl-3.0
- Created: 2024-06-05T12:24:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-04T07:26:49.000Z (about 1 year ago)
- Last Synced: 2025-04-03T15:22:40.819Z (3 months ago)
- Topics: gradekeeper-iitkgp, grades-iitkgp, kronos, kronos2, metakgp
- Language: Python
- Homepage: https://kronos.streamlit.app
- Size: 22.9 MB
- Stars: 4
- Watchers: 7
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Wiki][wiki-shield]][wiki-url]
Table of Contents
- [About The Project](#about-the-project)
- [Getting Started](#getting-started)
- [Using Docker](#using-docker)
- [Without Docker](#without-docker)
- [Contact](#contact)
- [Maintainer(s)](#maintainers)
- [Creator(s)](#creators)
- [Additional documentation](#additional-documentation)
## About The Project
This webapp displays previous year's grade distribution for the selected course. It has been hosted with streamlit as an app but is still under development.
You can find the container image [here on dockerhub](https://hub.docker.com/r/metakgporg/kronos).
## Getting started
To set up a local instance of the application, follow the steps below.
### Using docker
1. Pull the Docker image
```shell
docker pull metakgporg/kronos:latest
```
2. Run the container
```shell
docker run -p 8501:8501 metakgporg/kronos
```
> [!Note]
> You can change the `{PORT}:8501` to your desired PORT.
### Without docker
1. Configure the virtual environment
```shell
pip install virtualenv
virtualenv venv
source venv/bin/activate
```
2. Install Dependencies
```shell
pip install -r requirements.txt
```
3. Start the app
```shell
streamlit run app.py
```
## Contact
📫 Metakgp -
### Maintainer(s)
The currently active maintainer(s) of this project.
- [Arpit Bhardwaj](https://github.com/proffapt)
### Creator(s)
Honoring the original creator(s) and ideator(s) of this project.
- [Palkit Lohia](https://github.com/spookbite)
## Additional documentation
- [License](/LICENSE)
- [Code of Conduct](/.github/CODE_OF_CONDUCT.md)
- [Security Policy](/.github/SECURITY.md)
- [Contribution Guidelines](/.github/CONTRIBUTING.md)
[contributors-shield]: https://img.shields.io/github/contributors/metakgp/kronos.svg?style=for-the-badge
[contributors-url]: https://github.com/metakgp/kronos/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/metakgp/kronos.svg?style=for-the-badge
[forks-url]: https://github.com/metakgp/kronos/network/members
[stars-shield]: https://img.shields.io/github/stars/metakgp/kronos.svg?style=for-the-badge
[stars-url]: https://github.com/metakgp/kronos/stargazers
[issues-shield]: https://img.shields.io/github/issues/metakgp/kronos.svg?style=for-the-badge
[issues-url]: https://github.com/metakgp/kronos/issues
[license-shield]: https://img.shields.io/github/license/metakgp/kronos.svg?style=for-the-badge
[license-url]: https://github.com/metakgp/kronos/blob/main/LICENSE
[wiki-shield]: https://custom-icon-badges.demolab.com/badge/metakgp_wiki-grey?logo=metakgp_logo&style=for-the-badge
[wiki-url]: https://wiki.metakgp.org