knowledge-verificator 0.1.3

User's knowledge verificator

Knowledge Verificator

Knowledge Verificator is a tool for self-learning. It employs Natural Language Processing (NLP) techniques to facilitate and increase effectiveness of self-study. The project has been created as the Bachelor's Thesis of Igor Sosnowicz.

Using Knowledge Verificator is simple. Step by step:

1. Insert a paragraph you want to teach yourself or choose something from a databaset of predefined ones.
2. Knowledge Verificator generates a question for you.
3. You answer the question.
4. Your question is evaluated and you get the feedback.
5. The process repeats as long as you like.

Installation

Install with pipx

If you have pipx already installed, use:

pipx install knowledge-verificator

Install with pip

If you have pip already installed, use:

pip install knowledge-verificator

Usage

Run with pipx

If you have installed with pipx, run with:

pipx run knowledge-verificator

Run with pip

If you have installed with pip, run with:

python -m knowledge_verificator

Development

Prerequisites

You have to have the following tools installed:

• build and dependency management system: poetry
• npm - javascript package manager

Steps

Backend

1. Clone the repository.

   git clone [e-mail]:Iamhexi/knowledge_verificator.git
   

2. Enter its directory.

   cd knowledge_verificator
   

3. Install all dependencies, also including the optional ones.

   poetry install --with test
   

---

As a one-liner:

git clone [e-mail]:Iamhexi/knowledge_verificator.git && cd knowledge_verificator && poetry install --with test

Frontend

1. Change directory to frontend.

   cd frontend
   

2. Install the modules required by the frontend.

   npm install
   

---

As a one-liner:

cd frontend && npm install

---

And then run the application (make sure you are in the root directory of the repository).

poetry run python knowledge_verificator/main.py