README.md 1.32 KB
Newer Older
Cédric Moreau's avatar
Cédric Moreau committed
1
2
# Duniter website

Vincent Texier's avatar
Vincent Texier committed
3
Public site available at https://duniter.org/en
Cédric Moreau's avatar
Cédric Moreau committed
4
5
6
7
8
9
10
11

## Reproduce it locally

You may want to reproduce this website locally, for developement purposes for example. Here are the instructions.

Clone the sources

    git clone https://github.com/duniter/website.git
12

Cédric Moreau's avatar
Cédric Moreau committed
13
14
15
16
17
18
19
Install python stuff

    cd website
    virtualenv .
    source bin/activate
    pip install pelican pelican-youtube markdown beautifulsoup4

20
Install system dependencies for plantuml plugin (plantuml and GraphViz utilities) :
21
22
23
```bash
apt install plantuml graphviz
```
24

Cédric Moreau's avatar
Cédric Moreau committed
25
26
27
28
29
30
Generate the site

    pelican

Serve it

31
    ./develop_server.sh restart 8557
Cédric Moreau's avatar
Cédric Moreau committed
32

33
The website should be available at http://localhost:8557.
Cédric Moreau's avatar
Cédric Moreau committed
34
35
36
37
38
39
40
41
42
43
44
45

## Generate production site

You just need to give the production configuration file to Pelican:

    pelican -s publishconf.py

You may want to change the production parameters, like the domain name: just edit `publishconf.py` and modify the `SITEURL` to whatever value you want.

For example if you want to host the site at `https://my.website.org`, set:

    SITEURL = u'https://my.website.org'
46
47
48
49
50
51

## Plantuml plugin documentation

 * Plantuml plugin documentation : https://github.com/Scheirle/pelican-plugins/tree/master/plantuml
 * Plantuml documentation: http://plantuml.com
 * Plantuml support DOT language of GraphViz: http://www.graphviz.org/Gallery.php