hknweb

Welcome! This is the in-progress redesign for the HKN (Mu Chapter) website, built with Django.

Setup (Quick)

This approach is simpler if you are new to developing software.

Vagrant will automatically setup a virtual machine with the correct setup for developing hknweb.

Install Vagrant and VirtualBox, then run:

$ vagrant up

which will download and boot a Linux virtual machine, then run setup.

To access the environment, run

$ vagrant ssh

which will ssh your terminal into the virtual machine.

See Development for how to run the Django web server.

To turn off the virtual machine, run

$ vagrant halt

which will attempt to safely shutdown the virtual machine, or kill it otherwise.

Setup (Manual)

This approach requires less space, and is faster if your computer already has Python and GNU Make installed (i.e. most GNU/Linux machines.)

Developming hknweb requires pipenv, which will manage the Python virtualenv, selecting the correct Python version, and installing all dependencies.

On systems with sudo (root) privileges, you can run

$ pip install pipenv

For systems without sudo privileges, the following will work:

$ make setup

which will also install the Python dev environment (Python dependencies, a virtualenv). Without sudo privileges, you will need to add the binary location to your PATH variable. On Linux, this is ~/.local/bin, and on Windows, this is AppData\Roaming\Python\bin.

$ echo "export PATH="$PATH:$HOME/.local/bin" >> .bashrc

Django will also require a working copy of MySQL (or MariaDB).

Development

To run the Django development server (which runs a web server locally), run

$ make dev

or more simply,

$ make

In a Vagrant box, run

$ cd /vagrant
$ make dev-vagrant

which will make the web site available at http://localhost:3000.