README.md

# Hiboo

### Quickstart dev guide:

#### Dependencies:

Debian:
`
apt-get install python python-dev libmysqlclient-dev libpq-dev libxmlsec1-dev nodejs npm mariadb-server postgresql-libs python-pip python-virtualenv
`

Arch:
`
pacman -S git python python-pip python-virtualenv nodejs npm mariadb postgresql-libs
`

Fedora:
`
dnf install -y mysql-devel postgresql-devel xmlsec1-devel python3-devel libtool-ltdl-devel nodejs
`

Hiboo uses [poetry](https://python-poetry.org) as python dependencies manager.


#### Installation:

Clone Hiboo:
```
git clone https://forge.tedomum.net/acides/hiboo && cd hiboo
```

Install dependencies:
```
poetry install --with dev
npm ci
```

Import databases:
```
export FLASK_APP=hiboo
poetry run flask db upgrade
```

Generate the static folder:
```
./node_modules/.bin/webpack-cli
```

#### Run

```
export FLASK_APP=hiboo
poetry run flask run --reload
```

#### Translate

If you create or update messages in the `python`/`html` source files, don't forget to update the messages catalogs:
```sh
pybabel extract -F babel.cfg -o messages.pot hiboo/
pybabel update -i messages.pot -d hiboo/translations/
```

If you wish to contribute to the translation of Hiboo, join us on [the dedicated Weblate repository](https://glotte.felinn.org/projects/hiboo/forge-tedomum-hiboo/)

### 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.