Development environment

• Windows 10
• Python 3.9.6

Development

1. Clone this git repository git clone https://github.com/mhh008/favorites-link-page.git
2. Move into the directory cd favorites-link-page
3. Create a python virtual environment python -m venv ./venv
4. Activate the created environment ./venv/Scripts/activate
5. Install the required libraries pip install -r requirements.txt

Now you are ready to start for developing.

Production

1. Download the newest Release
2. Unpack the files
3. Create virtual environment, activate it, install required libraries (as explained in the Development section)
4. Run the main.py file with python and use the cli opptions dependign on the action you whant to do

Update to new release

1. Save your favorites_page.html file
2. See steps of the Production section to get the newer release
3. Copy the saved favorites_page.html file in the directory with the newer Release
4. Ready to work with the new release and keep your already created html page

MkDocs

In the project, the automated creation of documentation is basically implemented. The MkDocs module was used for this purpose.

By executing the command mkdocs serve a demonstration of this documentation is created and can be viewed in the browser.