Classrom Utility
==================
## Aim of the project 🎯
Aim of the project is to create website, that would help teachers with such activities as picking a random student or assigning pupils into groups.
As tasks like choosing random thing and grouping people are also common outside classroom, this project also aims to help everyone in need of asistance with those tasks.
### Customization
Another goal is for the website is to be customizable, to appeal to wide audience.
This, as of now, includes 4 available languages and 2 themes.
### Skill development
This project was created with no previous knowledge of *html*, *css*, *javascript*, *markdown* or *vector graphics*.
It's third goal was to learn basics of web development, utilizing available resources like **MDN Web Docs**, **W3Schools** and **StackOverflow**.
This project stands as a testimony, that this goal was achieved.
### AI disclaimer
As this project's goal was to learn web development, code in this project was mostly hand written.
I used AI in a few cases to search for bugs or validate execution of my ideas, because, as I have mentioned above, my web development skills were developing alongside the project.
## Single number module 🎲
This module of the website, supports generating single random number from a given range with the ability to remove certain numbers from the pool (e.g. students not present).
Additionally, it allows you to remove the number from the pool after being drawn or revert the pool to it's original state.
## Text module 📜
This module of the website, allows to pick a random text piece (called string in IT) from up to 12 texts specified by the user. Every text piece is limited up to 36 characters.
Main goal of the mode is to choose object from a pool without the need to order them and use number mode.
## Wheel 🛞
Both modes of the website utilizes a fortune wheel in order to be more entertaining.
This wheel is affected by all the changes in both text and number pool or theme of the website.
It also scales to remain around the same size on all screens.
## Features of the website 📊
The table below shows the current state of implentation of different features of the website.
| Part of the website | Multi-language | Themes | Screen scaling |
|:--------------------|:--------------:|:------:|:--------------:|
| Main Page | YES | YES | YES |
| Single Mode | YES | YES | NO |
| Text Mode | YES | YES | NO |
### Languages 📖
Currently website supports 4 languages. Those languages are:
- Polish,
- English,
- German,
- Latin.
As I am only proficient in polish and english, I would appreciate any help with improving translation of the other 2 languages (german and latin) or any initiative to add other languages.
Should you be willing to help with this task, contact me at or submit a pull request to [GitHub repository](https://github.com/D0nPeter/Classroom-utility/) of this project.
### Themes 🐸
Website supports changing themes.
Those themes are not standard light and dark mode but are rather supposed to be more cheerfull, inspired by different tales and sceneries like:
- **Frogs**,
- **Space**,
- Woods,
- Underwater
Bolded themes are present in the project.
## Working website 🌐
For those that do not want or know how to download this project from github you can check it out on my website.
If you want to visit main page of the website go [here](https://classroom-utility.qbitx.io/).
If you want to check out single mode go [here](https://classroom-utility.qbitx.io/single/).
Those websites are updated from time to time, yet the newest version of the project is always available on [github](https://github.com/D0nPeter/Classroom-utility/).
## Plans for future 📈
I plan to improve this project constantly. Goals for the future are shown in the table below.
| Part of the website | New features | Changes |
|:--------------------|:-------------|:--------|
| Main Page | - Image at the top of the page.
| |
| Single Mode | - Different backgrounds based on the current theme.
| |
| Text Mode | | |