MHD-Scanner

German Version

^{This project was originally made for Jugend hackt Berlin by Math, Nino6781, joshua and Farhan.
Many thanks to our Mentors Jannik, Jörg and Liv, and all the other people who helped.}

Table of Contents

• 1.0 Installing
• 2.0 Contributing
• 3.0 Troubleshooting
  • 3.1 Installation Errors
  • 3.2 Other Errors
• 4.0 Reference

With the MHD-Scanner, you can get points and play games by buying Groceries that expired just a few days ago. Thus you encourage people to buy food that isn't spoiled, but Supermarkets still dispose, because not enough people are buying it. It's a Win-Win Situation, both for the people, who can play games and for the environment.

---

1.0 Installing

First download the repo. The next step is to install python. This project probably needs python 3.5+, it was created with python 3.7. But you can install the latest version of python (currently 3.10.0).
Download Python
Don't forget to tick "Add Python to PATH", "Add Python to environment variables" and "pip"

To check if python's installed, open your terminal and type python -V.
If you get an error, go to Troubleshooting.

Now check if pip's installed. Type pip -h in the terminal.
If you get an error, go to Troubleshooting.

OPTIONAL: Because this project needs a lot of modules from pip, we recommend you to use a Virtual Environment. (make sure you are in the main directory)

Windows:

python -m venv env
.\env\Scripts\activate

Linux/Mac:

python3 -m venv env
source env/bin/activate

Great! Now install the modules from requirements.txt:

pip install -r requirements.txt

Now you can run the program with

python app.py

That's it! You did it! Now deactivate the venv:

Windows:

.\env\Scripts\deactivate.bat

Linux/Mac:

deactivate

If you want to run the project again, here are the steps:

1. Activate the venv:
   Windows:

   .\env\Scripts\activate
   

   Linux/Mac:

   activate

2. Run the project

   python app.py

3. Deactivate the venv
   Windows:

   .\env\Scripts\deactivate.bat
   

   Linux/Mac:

   deactivate

2.0 Contributing

We always welcome contributions. If you have any ideas or suggestions, please post an issue first with the tag enhancement. If you want to solve an issue, please leave a comment that you've been working on it. If you have made changes yourself, make a new branch and make a pull request and wait for one of the owners/members to merge it.

3.0 Troubleshooting

3.1 Installation Errors

'python' is not recognized as an internal or external command, operable program, or batch file.
That means you haven't installed python correctly, or it's not in the PATH variable.

Try:

• python3 -V
• py -V
• python [PYTHONVERSION.PYTHONVERSION] e.g. python 3.10

If both commands don't work, try to uninstall python and install it with the instructions above.

'pip' is not recognized as an internal or external command, operable program, or batch file.
That means you haven't installed pip when you installed python, or it's not in the PATH variable.

Try:

• pip3 -V
• pip -V

If both commands don't work, install pip.

3.1 Other errors

If you have any other errors, program, or installing errors we didn't mention, don't hesitate to open an issue with the tag bug. Or write an e-mail to mhd.team[at]outlook.de

---

3.0 Reference

Github: https://github.com/Jugendhackt/MHD-Main
License: https://github.com/Jugendhackt/MHD-Main/blob/main/LICENSE
Discord: https://discord.com/channels/897766520476827669/897766520476827672
Jugend Hackt: https://jugendhackt.org/