This guide details the steps to set up Huxley on OS X. Use this if you'd like to customize your setup, or had trouble with the setup script.
Virtualenv separates your project's Python modules from the rest of your system to prevent conflicts. We'll install virtualenv and a useful utility built on top of it, virtualenvwrapper.
$ sudo pip install virtualenv
$ sudo pip install virtualenvwrapper
Add the following two lines to your .bash_profile and source it:
export WORKON_HOME="$HOME/.virtualenvs"
source /usr/local/bin/virtualenvwrapper.sh
# And in terminal:
$ source ~/.bash_profile
You'll then be able to create a virtualenv for Huxley:
$ mkvirtualenv huxley
From now on, whenever you're going to work on Huxley, just remember to switch to your huxley virtualenv (and deactivate it when you're done):
$ workon huxley # When you're about to begin work
...hack...
$ deactivate # After you're done
Hub is a command line interface to GitHub. It's optional for Huxley, but it certainly makes issuing pull requests easier. Install it using Homebrew, with
$ brew install hub
Begin by creating a fork of this repository. Go to the top-right of this repository page and click "Fork" (read Github's guide for a refresher on forking. If you're new to GitHub, remember to set up SSH keys as well). Then, clone your repository, cd into it, and add this one as an upstream remote:
$ git clone [email protected]:yourusername/huxley.git
$ cd huxley
$ git remote add upstream https://github.com/kmeht/huxley.git
Next, configure your author information. Use your name and email as they appear on GitHub:
$ git config user.name "Your Name"
$ git config user.email "[email protected]"
Install the Python dependencies with the provided requirements.txt (remember to activate the huxley virtualenv!):
$ pip install -r requirements.txt
Install the JS dependencies with the provided package.json using npm:
$ npm install
The first step is to prepare the database. We do that by running:
$ python manage.py runserver
Running the server will automatically create a database for us at huxley/huxley.db. Once you've run the server exit it (CONTROL-C), and then run:
$ python manage.py migrate
$ python manage.py loaddata conference countries committees advisor chair
Finally, we use Pipeline to collect, compile, and compress our static assets. It simply hooks into Django's collectstatic management command:
$ python manage.py collectstatic --noinput
If you run into an error here run ulimit -n 512. This will increase the number of files the process running Huxley will be allowed to open.
Next, you need to compile your JS code by running:
$ npm run build
Lastly, open up a new tab in your terminal (make sure you're still in your virtualenv), and spin up a development server:
$ python manage.py runserver
You can access Huxley at localhost:8000.
If you haven't created a superuser yet, you should do that now:
$ python manage.py createsuperuser
Your superuser credentials is what will allow you to login to the admin panel at localhost:8000/admin/.
To check out the other management commands at your disposal run python manage.py. This will list out all possible management commands. Many of these commands will be useful to keep your development environment in check.
With that, you're ready to go; start hacking!