Sorting Hat 🎩

🔰 Sorting Hat is a tool that empowers students to find their best suited learning methodology, backed up by extensive research and well known psycology concepts.

🧑‍💻 It uses the powers of predictive language models to interpret a series of open-ended answers so that all the relevant information is extracted to be used with traditional learning methodoly identification approaches.

📊 Sorting Hat can also be used by institutions to identify the profiles of each freshman student and organize them into classes that share a similar learning methodology to optimize teacher eficiency by using the best suited approach for that class.

Table Of Contents

• Usage
  • No sign in student
  • Student with result history enabled
  • Teacher, Institution or Organization
• Hosting
  • 1. Setup
  • 2. Environment
  • 3. Run
• License

Usage

• 🤓 No sign in student:

To take the test once and immediately see your results:

1. Take the quiz.
2. See the result.

• 🧑‍🎓 Student with result history enabled:

To be able to keep track of your own history of results through time and compare results:

1. Sign in as a student to the Sorting Hat platform
2. Take the quiz.
3. See the result.

• 👥 Teacher, Institution or Organization:

To be able to apply the quiz for multiple members of your hierarchy and have access to their results:

1. Sign in as a teacher to the Sorting Hat platform.
2. Share the invitation token with participants.
3. See the results.

Hosting

To be able to host a Sorting Hat server you will need:

• Rust,
• Diesel CLI,
• NPM,
• Docker with docker-compose,
• and access to a PostgreSQL database.

1. Setup

1. Sorting Hat requires the Nighly version of rust, so you need to install it if not present:

rustup toolchain install nightly

2. In the project directory you'll need to run

rustup override set nightly

3. To install diesel_cli with postgres support:

cargo install diesel_cli --no-default-features --features postgres

2. Environment

1. To be able to run Sorting Hat on your machine, Docker must be enabled or active.

• On windows: this can be done by ensuring that the Docker icon is present at your system tray.

• On Unix: you can start the Docker Daemon before running Sorting Hat with the command:

sudo systemctl start docker

... or configure it to always start at boot with:

sudo systemctl enable docker.service

2. You will also need a PostgreSQL connection and provide the credentials to the program via the .env file.

3. Run

1. With everything set-up, run run.sh (On Linux or MacOS) or run.bat (On Windows) to start the server.

• Unix:

./run.sh

• Windows:

./run.bat

License

This project is licensed under the MIT License - see the LICENSE file for details. Feel free to use, modify, and distribute the code as per the terms of the MIT License.