The latest UWaterloo HvZ website. Built on Django.
To create a local instance of the site for development:
git clone [email protected]:uwhvz/uwhvz.git
pipenv install
pipenv shell
python manage.py migrate
python manage.py runserverpython manage.py seed_datagenerates a bunch of fake data for testing purposes.python manage.py makemigrations appto make a migration after changing models, etc.
The website has a public API currently under development. You can check out the documentation here.
The site is currently hosted on: Computer Science Club (CSC) servers.
We use a detached screen to run Gunicorn, which lets us run the site. Important commands include:
screen -S gunicorn: create a new screen to be detachable named "gunicorn"screen -ls: should list exactly one detached screen where Gunicorn is running the sitescreen -r: resumes the Gunicorn screen
If no screen is found, do the following:
screen -S gunicorn
source venv/bin/activate
gunicorn --bind 0.0.0.0:53271 uwhvz.wsgiExit out of the screen session (but keep it running) with Ctrl+A+D. Failure to do this will make restarting the server significantly harder. Afterwards, check if the website is online.
If frontend-related changes are not refreshed on the site originally upon pulling, use python manage.py collectstatic, and restart the server. If that doesn't work, do the following:
rm -rf /static/
python manage.py collectstatic
python manage.py compress --engine jinja2The last line is for optimizing the size of our assets. Failure to run the last line will cause a 500 error.
- If anything is wrong, make an issue on the repo.
- If you are willing to take an issue/task on, do step 1 if it's not already logged, assign yourself, and make a PR!
- Your PR needs to be approved by an admin.
- Once you're approved, you can merge and celebrate 🎉