Skip to content

Boiiterra/math_problem_generator_app

Repository files navigation

Navigation

Description in another languages:

-- Russian --


Link to project's website


Math Problem Generator App

Description

This application was created as school project and it generates certain math problems. Math problems has their unique number which allows you to return to that specific exercise at any time and solve it as many times as you want.

Installation

Windows

  1. Click me to start downloading "mathproblemgenerator_setup.exe" file
  2. After download is finished open mathproblemgenerator_setup.exe
  3. Complete installation by choosing options you like
  4. After finishing this process app will be opened or you need to double click it on your desktop, start menu or find it in the destination folder you picked (Targeted file is Math problem generator launcher.exe)

Linux

Currently working on it. But you can do this in console:
SSH:

git clone [email protected]:TerraBoii/math_problem_generator_app.git
cd math_problem_generator_app
pip install -r requirements.txt
./main_app.py

HTTPS

git clone https://github.com/TerraBoii/math_problem_generator_app.git
cd math_problem_generator_app
pip install -r requirements.txt
./main_app.py

(back to top)

Structure of the project

  • ./
    • app_installer/
      • mathproblemgenerator_setup.exe
    • automation/
      • artist.py
      • writer.py
    • images/
      • main_icon.ico
      • uninstaller.ico
      • update_icon.ico
      • update_manager.jpg
    • modules/
    • .gitignore
    • LICENSE
    • README.md
    • README_ru.md
    • add_task.sh
    • backup_data.txt
    • data.txt
    • defaults.txt
    • installer_icon.ico
    • launcher.py
    • main_app.py
    • main_icon.ico |--> used for pyinstaller
    • requirements.txt
    • update_icon.ico |--> used for pyinstaller
    • version.txt

(back to top)

About generators

All generators are stored in ./modules/generators/ directory. I won't list them as they will increase over time. Generators are used in task pages. In order to create new generator check: how to create new task.
! Do not create page without checking New task creation !

About pages

All pages are stored in ./modules/pages/ directory. I won't list them as they will increase over time. Pages are used in main_app.py. In order to create new page check: how to create new task.
! Do not create page without checking New task creation !

(back to top)


New task creation

You can create pages manually or automatically.

Manual

Use automatic please.
Manual is harder than automatic.

Automatic

Works on Linux (probably on MacOS too): / If your current working directory is .../math_problem_generator_app/ then open terminal and type:

./add_task.sh <task_name>

Then you can open ./modules/pages/<Task_Name>Page.py and ./modules/generators/<task_name>.py and edit them.
Important note: Make sure that you added <Task_Name>Page.py as import from modules into main_app.py + into pages dictionary (it is located under __version__ and author variables).

If you use Windows - you probably need to google "how to run shell scripts" or create .bat ones and contribute them if you want.

(back to top)