bornhack-website/README.md

140 lines
4.2 KiB
Markdown
Raw Normal View History

2015-10-03 01:07:05 +00:00
# Bornhack
2019-03-29 20:00:34 +00:00
[![Build Status](https://travis-ci.org/bornhack/bornhack-website.svg?branch=master)](https://travis-ci.org/bornhack/bornhack-website)
[![codecov](https://codecov.io/gh/bornhack/bornhack-website/branch/master/graph/badge.svg)](https://codecov.io/gh/bornhack/bornhack-website)
Django project to power Bornhack. Features include news, villages, webshop, and more.
2015-10-03 01:07:05 +00:00
## Development setup
2015-10-03 01:07:05 +00:00
### Clone the repo
Clone with --recursive to include submodules:
git clone --recursive https://github.com/bornhack/bornhack-website
If you already cloned the repository without --recursive, you can change into the directory and add the submodules with:
git submodule update --init --recursive
### Virtualenv
Create a Python 3 virtual environment and activate it:
2017-01-20 16:47:10 +00:00
```
$ virtualenv venv -p python3
2017-01-20 16:47:10 +00:00
$ source venv/bin/activate
```
2016-07-03 12:27:31 +00:00
If you installed python3 using Homebrew on macOS, you will need to install virtualenv by runinng the following command first:
```
pip3 install virtualenv
```
### System libraries
Install system dependencies (method depends on OS):
2017-01-28 16:06:46 +00:00
- postgresql headers (for psycopg2):
- Debian: libpq-dev
- FreeBSD: databases/postgresql93-client
- macOS: If using the PostgreSQL.app, the headers are included, only path needs to be added
- libjpeg (for pdf generation)
2017-01-20 16:47:10 +00:00
- Debian: libjpeg-dev
2017-01-31 17:52:40 +00:00
- FreeBSD: graphics/jpeg-turbo
- macOS: brew install libjpeg
- libmagic (might already be installed)
- macOS: brew install libmagic
- wkhtmltopdf (also for pdf generation):
- Debian: wkhtmltopdf
- FreeBSD: converters/wkhtmltopdf
- macOS: install from https://wkhtmltopdf.org/
2017-03-30 07:36:29 +00:00
- fonts
- Debian: ?
- FreeBSD: x11-fonts/webfonts
- macOS: ?
2016-07-03 12:27:31 +00:00
### Python packages
2017-01-20 16:47:10 +00:00
Install pip packages:
```
(venv) $ pip install -r src/requirements/dev.txt
2017-01-20 16:47:10 +00:00
```
2016-07-03 12:27:31 +00:00
### Postgres
You need to have a running Postgres instance (we use Postgres-specific datetime range fields). Install Postgress, and add a database `bornhack` (or whichever you like) with some way for the application to connect to it, for instance adding a user with a password.
You can also use Unix socket connections if you know how to. It's faster, easier and perhaps more secure.
### Configuration file
Copy dev environment settings file and change settings as needed:
2017-01-20 16:47:10 +00:00
```
(venv) $ cp src/bornhack/environment_settings.py.dist.dev src/bornhack/environment_settings.py
2017-01-20 16:47:10 +00:00
```
2016-07-03 12:27:31 +00:00
Edit the configuration file, setting up `DATABASES` matching your Postgres settings.
2017-08-28 19:28:27 +00:00
### Database
Is this a new installation? Initialize the database:
2017-01-20 16:47:10 +00:00
```
(venv) $ src/manage.py migrate
2017-01-20 16:47:10 +00:00
```
Is this for local development? Bootstrap the database with dummy data and users:
2017-01-20 16:47:10 +00:00
```
(venv) $ src/manage.py bootstrap-devsite
2017-01-20 16:47:10 +00:00
```
2017-08-28 20:29:38 +00:00
### Done
2017-08-28 20:29:38 +00:00
Is this for local development? Start the Django devserver:
```
(venv) $ src/manage.py runserver
2017-08-28 20:29:38 +00:00
```
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`
## Contributors
2018-03-04 14:55:18 +00:00
* Alexander Færøy https://github.com/ahf
* Benjamin Bach https://github.com/benjaoming
* coral https://github.com/coral
* Henrik Kramshøj https://github.com/kramse
* Janus Troelsen https://github.com/ysangkok
* Jeppe Ernst https://github.com/Ern-st
2018-03-04 14:55:18 +00:00
* Jonty Wareing https://github.com/Jonty
* Kasper Christensen https://github.com/fALKENdk
* klarstrup https://github.com/klarstrup
* kugg https://github.com/kugg
* lgandersen https://github.com/lgandersen
2018-03-04 14:55:18 +00:00
* RadicalPet https://github.com/RadicalPet
* Reynir Björnsson https://github.com/reynir
* Ronni Elken Lindsgaard https://github.com/rlindsgaard
* Stephan Telling https://github.com/Telling
* Thomas Flummer https://github.com/flummer
2018-03-04 14:55:18 +00:00
* Thomas Steen Rasmusssen https://github.com/tykling
* Víðir Valberg Guðmundsson https://github.com/valberg
* Ximin Luo https://github.com/infinity0