bornhack-website/README.md

# Bornhack

Django project to power Bornhack. Features include news, villages, webshop, and more.

## Quickstart

### Using docker-compose

If you have docker-compose you can use the included make file. Like so:

    $ make

This will create everything. You can now start the project running:

    $ make run

### Manual way

#### Clone the repo
Clone with --recursive to include submodules:

    git clone --recursive https://github.com/bornhack/bornhack-website

If you already cloned the repository, you can add the submodules like this:

    git submodule update --init --recursive

#### Virtualenv
Create a Python 3 virtual environment and activate it:
```
$ virtualenv venv -p python3
$ source venv/bin/activate
```

#### System libraries
Install system dependencies (method depends on OS):
- postgresql headers (for psycopg2):
  - Debian: libpq-dev
  - FreeBSD: databases/postgresql93-client
- libjpeg (for pdf generation)
  - Debian: libjpeg-dev
  - FreeBSD: graphics/jpeg-turbo
- wkhtmltopdf (also for pdf generation):
  - Debian: wkhtmltopdf
  - FreeBSD: converters/wkhtmltopdf
- fonts
  - Debian: ?
  - FreeBSD: x11-fonts/webfonts

#### Python packages
Install pip packages:
```
    (venv) $ pip install -r src/requirements.txt
```

#### Configuration file
Copy environment settings file and change settings as needed:
```
    (venv) $ cp src/bornhack/environment_settings.py.dist src/bornhack/environment_settings.py
```

Edit the configuration file, replacing all the ``{{ placeholder }}`` patterns
(intended for Ansible).

#### Database
Is this a new installation? Initialize the database:
```
    (venv) $ src/manage.py migrate
```

Is this for local development? Bootstrap the database with dummy data and users:
```
    (venv) $ src/manage.py bootstrap-devsite
```

#### Deploy camps+program test data

Run this command to create a bunch of nice test data:

```
    (venv) $ src/manage.py bootstrap-devsite
```


#### Done
Is this for local development? Start the Django devserver:
```
    (venv) $ src/manage.py runserver
```

Otherwise start uwsgi or similar to serve the application.

Enjoy!

## Notes

### Add a camp

Add a new camp by running:

```
    (venv) $ src/manage.py createcamp {camp-slug}
```

Then go to the admin interface to edit the camp details, adding the same slug
that you just used and some current dates.

You can also specify details like:

* A sponsors page, `{camp-slug}_sponsors.html`, to `sponsors/templates`.
* A frontpage, `{camp-slug}_camp_detail.html`, to `camps/templates`.
* A call for speakers page, `{camp-slug}_call_for_speakers.html`, to `program/templates`.
* A `static_src/img/{camp-slug}/logo` and add two logos:
    * `{camp-slug}-logo-large.png`
    * `{camp-slug}-logo-small.png`

### multicamp prod migration notes

* when villages.0008 migration fails go add camp_id to all existing villages
* go to admin interface and add bornhack 2017, and set slug for bornhack 2016
* convert events to the new format (somehow)