README.md 1.26 KB
Newer Older
Jae Beojkkoch's avatar
Jae Beojkkoch committed
1 2 3 4
# Hiboo

### Quickstart dev guide:

Jae Beojkkoch's avatar
Jae Beojkkoch committed
5
#### Dependencies:  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
6
Debian:  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
7
`
Jeremy's avatar
Jeremy committed
8
apt-get install python python-dev libmysqlclient-dev libpq-dev libxmlsec1-dev nodejs npm mariadb-server postgresql-libs python-pip python-virtualenv
Jae Beojkkoch's avatar
Jae Beojkkoch committed
9
`
Jae Beojkkoch's avatar
Jae Beojkkoch committed
10

Jae Beojkkoch's avatar
Jae Beojkkoch committed
11
Arch:  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
12
`
Jae Beojkkoch's avatar
Jae Beojkkoch committed
13
pacman -S git python python-pip python-virtualenv nodejs npm mariadb-server postgresql-libs  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
14 15
`

16 17
Fedora:  
`
Jae Beojkkoch's avatar
Jae Beojkkoch committed
18
dnf install -y mysql-devel postgresql-devel xmlsec1-devel python3-devel libtool-ltdl-devel nodejs
19 20
`

Jae Beojkkoch's avatar
Jae Beojkkoch committed
21 22 23 24
---

#### Installation:

Jae Beojkkoch's avatar
Jae Beojkkoch committed
25
Clone Hiboo:  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
26
`
Jae Beojkkoch's avatar
Jae Beojkkoch committed
27
git clone https://forge.tedomum.net/acides/hiboo && cd hiboo 
Jae Beojkkoch's avatar
Jae Beojkkoch committed
28 29
`

Jae Beojkkoch's avatar
Jae Beojkkoch committed
30
Create virtualenv and activate it:  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
31
`
Jae Beojkkoch's avatar
Jae Beojkkoch committed
32
mkdir venv && virtualenv venv && source venv/bin/activate  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
33 34
`

Jae Beojkkoch's avatar
Jae Beojkkoch committed
35
Install dependencies:  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
36
`
Jeremy's avatar
Jeremy committed
37 38 39 40
pip install -r requirements.txt
pip install Werkzeug==0.16.0
pip install Pillow
pip install email_validator
Jae Beojkkoch's avatar
Jae Beojkkoch committed
41 42
`

Jae Beojkkoch's avatar
Jae Beojkkoch committed
43 44 45 46 47
Import databases:
`
flask db upgrade
`

Jae Beojkkoch's avatar
Jae Beojkkoch committed
48
Generate the static folder:  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
49
`
Jae Beojkkoch's avatar
Jae Beojkkoch committed
50
npm install; ./node_modules/.bin/webpack-cli  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
51 52
`

Jae Beojkkoch's avatar
Jae Beojkkoch committed
53
Run:  
Jae Beojkkoch's avatar
Jae Beojkkoch committed
54
`
Jae Beojkkoch's avatar
Jae Beojkkoch committed
55
export FLASK_APP=hiboo; flask run  
56 57 58 59 60 61 62 63 64 65 66 67 68 69
`

### Test instance

Our test instance is running at: https://auth.test.tedomum.net

You can find some test services at :

 - https://write.test.tedomum.net
 - https://seafile.test.tedomum.net
 - https://nextcloud.test.tedomum.net
 - https://riot.test.tedomum.net

Please contact us if you want specific permissions on the test instance.