Skip to content

Installation, running local build, updating articles

William Washington edited this page Aug 26, 2024 · 3 revisions

Initial set up

  1. sudo apt install python3 python3-pip (Not needed for Macs)
  2. python3 -m pip install --upgrade pip setuptools wheel (Check to see if already installed using “python3 -v” If so, skip this step)
  3. pip install --upgrade pycodestyle (Should already be included on a Mac and not needed)
  4. pip install --upgrade virtualenv (Should already be included on a Mac and not needed)
  5. git clone https://github.com/uw-it-aca/hx-toolkit.git
  6. edit project/settings.py,
    1. add 'hx_toolkit' to INSTALLED_APPS list
    2. add MEDIA_URL = '/uploaded_images/'
    3. add MEDIA_ROOT = BASE_DIR / '/hx_images'

Get your personal build up

  1. cd hx-toolkit
  2. 'python3 -m venv .'
  3. source bin/activate
  4. pip3 install .
  5. django-admin startproject project .
  6. pip3 install .

Run server

  1. source bin/activate
  2. ./manage.py runserver localhost:8899
  3. Open admin interface at: http://localhost:8899/admin/
 (user: thrive, password: spiffyhellbentbadger)

Update articles

  1. make a new branch from main
  2. edit articles in admin interface
  3. once editing is complete, run command ./manage.py thrive
  4. Commit and push changed files
  5. Make new release on HXT repository

Published at https://pypi.org/project/UW-HX-Toolkit/