86 lines
3.3 KiB
Markdown
86 lines
3.3 KiB
Markdown
Pillar
|
|
======
|
|
|
|
This is the latest iteration on the Attract project. We are building a unified
|
|
framework called Pillar. Pillar will combine Blender Cloud and Attract. You
|
|
can see Pillar in action on the [Blender Cloud](https://cloud.bender.org).
|
|
|
|
## Custom fonts
|
|
|
|
The icons on the website are drawn using a custom font, stored in
|
|
[pillar/web/static/font](pillar/web/static/font).
|
|
This font is generated via [Fontello](http://fontello.com/) by uploading
|
|
[pillar/web/static/font/config.json](pillar/web/static/font/config.json).
|
|
|
|
Note that we only use the WOFF and WOFF2 formats, and discard the others
|
|
supplied by Fontello.
|
|
|
|
After replacing the font files & `config.json`, edit the Fontello-supplied
|
|
`font.css` to remove all font formats except `woff` and `woff2`. Then upload
|
|
it to [css2sass](http://css2sass.herokuapp.com/) to convert it to SASS, and
|
|
place it in [src/styles/font-pillar.sass](src/styles/font-pillar.sass).
|
|
|
|
Don't forget to Gulp!
|
|
|
|
|
|
## Installation
|
|
|
|
Dependencies are managed via [Poetry](https://poetry.eustace.io/).
|
|
|
|
Make sure your /data directory exists and is writable by the current user.
|
|
Alternatively, provide a `pillar/config_local.py` that changes the relevant
|
|
settings.
|
|
|
|
```
|
|
git clone git@git.blender.org:pillar-python-sdk.git ../pillar-python-sdk
|
|
pip install -U --user poetry
|
|
poetry install
|
|
```
|
|
|
|
## HDRi viewer
|
|
|
|
The HDRi viewer uses [Google VRView](https://github.com/googlevr/vrview). To upgrade,
|
|
get those files:
|
|
|
|
* [three.min.js](https://raw.githubusercontent.com/googlevr/vrview/master/build/three.min.js)
|
|
* [embed.min.js](https://raw.githubusercontent.com/googlevr/vrview/master/build/embed.min.js)
|
|
* [loading.gif](https://raw.githubusercontent.com/googlevr/vrview/master/images/loading.gif)
|
|
|
|
and place them in `pillar/web/static/assets/vrview`. Replace `images/loading.gif` in `embed.min.js` with `static/pillar/assets/vrview/loading.gif`.
|
|
|
|
You may also want to compare their
|
|
[index.html](https://raw.githubusercontent.com/googlevr/vrview/master/index.html) to our
|
|
`src/templates/vrview.pug`.
|
|
|
|
When on a HDRi page with the viewer embedded, use this JavaScript code to find the current
|
|
yaw: `vrview_window.contentWindow.yaw()`. This can be passed as `default_yaw` parameter to
|
|
the iframe.
|
|
|
|
## Celery
|
|
|
|
Pillar requires [Celery](http://www.celeryproject.org/) for background task processing. This in
|
|
turn requires a backend and a broker, for which the default Pillar configuration uses Redis and
|
|
RabbitMQ.
|
|
|
|
You can run the Celery Worker using `manage.py celery worker`.
|
|
|
|
Find other Celery operations with the `manage.py celery` command.
|
|
|
|
## Elasticsearch
|
|
|
|
Pillar uses [Elasticsearch](https://www.elastic.co/products/elasticsearch) to power the search engine.
|
|
You will need to run the `manage.py elastic reset_index` command to initialize the indexing.
|
|
If you need to reindex your documents in elastic you run the `manage.py elastic reindex` command.
|
|
|
|
## Translations
|
|
|
|
If the language you want to support doesn't exist, you need to run: `translations init es_AR`.
|
|
|
|
Every time a new string is marked for translation you need to update the entire catalog: `translations update`
|
|
|
|
And once more strings are translated, you need to compile the translations: `translations compile`
|
|
|
|
*To mark strings strings for translations in Python scripts you need to
|
|
wrap them with the `flask_babel.gettext` function.
|
|
For .pug templates wrap them with `_()`.*
|