bornhack-website/README.md

45 lines
1.3 KiB
Markdown
Raw Normal View History

2015-10-03 01:07:05 +00:00
# Bornhack
Django project to power Bornhack.
2016-02-14 13:20:07 +00:00
Features do not include:
2015-10-03 01:07:05 +00:00
- Create camp
- Control expenses for a camp
- Manage signups for attendees for a camp
- ...
## Quickstart
Create a Python 2.7 virtual environment and activate it:
2016-07-03 12:27:31 +00:00
$ virtualenv venv
$ source venv/bin/activate
Install dependencies:
(venv) $ pip install -r requirements/development.txt
Copy environment file and change settings like DATABASE_URL:
(venv) $ cp bornhack/settings/env.dist bornhack/settings/.env
Run `make` (removing USE_SQLITE=1 if you want to use postgres)
2016-07-03 12:27:31 +00:00
(venv) $ SQLITE=1 make
2016-07-03 12:27:31 +00:00
Which is equivalent with this:
(venv) $ ./manage.py migrate --settings=bornhack.settings.development
(venv) $ ./manage.py createsuperuser --settings=bornhack.settings.development
(venv) $ ./manage.py runserver --settings=bornhack.settings.development
### Setting up Postgres
Using Postgres is only necessary for purposes of the special
[JSONField](https://docs.djangoproject.com/en/1.10/ref/contrib/postgres/fields/).
The field is active on our shop mainly, so you can still develop things for most
parts of the site without installing Postgres.
To use default settings and make commands, create a user `bornhack`, password
`bornhack` and database `bornhack_dev` to use default setttings.