Execution with python

Prerequisites
Python 3.11 or later (make sure to select Add to PATH during installation) and Git installed.

Automatic


  1. Navigate to a directory of your choice and open a command line interface (e.g. Git Bash) and execute

    git clone https://github.com/core4x/collectu-core.git

  2. Execute install_local.

    For Windows:

    Double click on:

    bin\windows\install_local.bat

    For Linux:

    Make the file executable with:

    sudo chmod +x install_local.sh

    Execute with:

    sudo bin/linux/install_local.sh

  3. Log in, if you are not.

  4. Create an api access token. Download the created token and save it in the root directory (/collectu-core).

  5. If you have subscribed to a plan, download your personal git access token and place the file in the root directory (/collectu-core).

  6. Start the application.

    For Windows:

    Double click on:

    bin\windows\start_local.bat

    For Linux:

    Make the file executable with:

    sudo chmod +x start_local.sh

    Execute with:

    sudo bin/linux/start_local.sh

  7. Continue with our First Steps.
Info
If you close the terminal, the application is stopped. If you want to run the application in background, execute the according scripts (start_local_background).

Manual

  1. Navigate to a directory of your choice and open a command line interface (e.g. Git Bash) and execute

    git clone https://github.com/core4x/collectu-core.git

  2. Open a command line interface as administrator in the cloned folder (/collectu-core). To navigate, use cd collectu-core

  3. Create a virtual environment.

    python -m venv venv

  4. Activate the virtual environment.

    For Windows:

    venv\Scripts\activate

    For Linux:

    source venv/bin/activate

  5. Install the requirements.

    For Windows:

    pip install -r src\requirements.txt

    For Linux:

    pip install -r src/requirements.txt

  6. Log in, if you are not.

  7. Create an api access token. Download the created token and save it in the root directory (/collectu-core).

  8. If you have subscribed to a plan, download your personal git access token and insert the file in the root directory (/collectu-core).

  9. Only required if you subscribed to a plan and manually added the git_access_token file: Update the application with activated virtual environment.

    For Windows:

    python src\main.py --update

    For Linux:

    python src/main.py --update

  10. Start the application with activated virtual environment.

    For Windows:

    python src\main.py

    For Linux:

    python src/main.py

  11. Continue with our First Steps.