README.md 2.11 KB
Newer Older
Thom Wiggers's avatar
Thom Wiggers committed
1
2
3
4
5
6
Thalia Website
==============

New new Thalia website, now with extra Django.

    #Concrexit
Thom Wiggers's avatar
Thom Wiggers committed
7
8
9
10

Getting started
---------------

Luuk Scholten's avatar
Luuk Scholten committed
11
12
0. Get at least Python 3.4 and install the Pillow requirements as per below.
   Also make sure that you have `lessc` installed (see below).
Thom Wiggers's avatar
Thom Wiggers committed
13
14
15
16
17
18
1. Clone this repository
2. Run `source ./source_me.sh` (or use your own favourite virtualenv solution)
3. Run `pip install -r requirements.txt`
4. Run `pip install -r dev-requirements.txt`
5. `cd website`
6. `./manage.py migrate` to initialise the database
Thom Wiggers's avatar
Thom Wiggers committed
19
20
7. `./manage.py createsuperuser` to create the first user (note that this user won't be a member!)
8. `./manage.py runserver` to run a testing server
Thom Wiggers's avatar
Thom Wiggers committed
21
22
23
24
25

Testing and linting
-------------------

1. In the root folder of the project, run `tox`.
26
27
28
29
30
31
32

You may get errors about missing interpreters. That is normal and can be 
ignored. If you want to run a specific check, you can do the following:

    tox -e flake8  # Runs the flake8 linter
    tox -e py34    # runs the tests with python 3.4
    tox -e py35    # runs the tests with python 3.5
Thom Wiggers's avatar
Thom Wiggers committed
33
34
35
36
37
38

Pillow dependencies
-------------------

For Ubuntu 16.04, use:

39
    apt-get install python3-dev gettext gcc build-essential libtiff5-dev libjpeg62-turbo-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev
Thom Wiggers's avatar
Thom Wiggers committed
40

Thom Wiggers's avatar
Thom Wiggers committed
41
42
43
44
Or try:

    apt-get build-dep python3-pil

Luuk Scholten's avatar
Luuk Scholten committed
45
For other operating systems, see the [Pillow Documentation][pillow-install].
Thom Wiggers's avatar
Thom Wiggers committed
46
47
48


[pillow-install]: https://pillow.readthedocs.io/en/latest/installation.html
Luuk Scholten's avatar
Luuk Scholten committed
49
50
51
52

NodeJS dependencies
-----------------------
1. `lessc`:
Joost Rijneveld's avatar
Joost Rijneveld committed
53
   * On Ubuntu or Debian, use: `apt-get install node-less node-mkdirp`
54

Joost Rijneveld's avatar
Joost Rijneveld committed
55
56
57
58
59
60
61
Thabloid dependencies
---------------------

To be able to generate JPGs from PDFs, we need ghostscript:

    apt-get install ghostscript

62
63
64
65
66
67
68
69
70
71
72
Translating
------------------

Make sure to use British English.

To create translations for your app:

1. `./manage.py makemessages <appname>`
2. Dit zou bestanden onder `<appnaam>/locale/` aangemaakt of bijgewerkt moeten hebben.
3. Gebruik poedit (of je favoriete tool -- liever niet een simpele texteditor want die kan niet met alle subtiliteiten omgaan) om de vertaling te fixen.
4. `./manage.py compilemessages`