@ -20,14 +20,14 @@ These instructions will get you a copy of the project up and running on your loc
### Prerequisites
To install Hubl, you'll need:
To install Orbit, you'll need:
* A [Hubl Server](https://git.startinblox.com/djangoldp-packages/server-manager/) (djangoldp>2)
* A [DjangoLDP Server](https://git.startinblox.com/djangoldp-packages/server-manager/) (djangoldp>2)
* A [Prosody Server](https://prosody.im/) (with [appropriate modules](https://git.startinblox.com/infra/prosody-modules/)) (optional)
* A SMTP Server (optional)
* NodeJS on your machine
Before diving in you have to check your Hubl Server supports the following LDP packages:
Before diving in you have to check your DjangoLDP Server supports the following LDP packages:
* djangoldp_account
* djangoldp_uploader
@ -35,23 +35,23 @@ Before diving in you have to check your Hubl Server supports the following LDP p
Those packages are given with the last stable version tested.
Refer to the [documentation to install a Hubl Server](https://docs.startinblox.com/import_documentation/install-djangoldp-server.html) with this configuration.
Refer to the [documentation to install a DjangoLDP Server](https://docs.startinblox.com/import_documentation/install-djangoldp-server.html) with this configuration.
## Build the application
In order to find your server(s) the client application needs to be assembled with the proper configuration.
Get the code of the Hubl on your machine:
Get the code of the Orbit on your machine:
```bash
git clone ...
cd hubl
cd orbit
npm install
```
Then create a `config.json` based on your needs, see Mandatory and Optional Modules on this page. For convienence a `config.sample.json` exists in the source.
Then build your new Hubl:
Then build your new Orbit:
```bash
npm run build
@ -87,7 +87,7 @@ CONFIG_PATH='config.customName.json' npm run build
## Mandatory modules
By default, a Hubl includes only individual chat modules.
By default, a Orbit includes only individual chat modules.
On Server: `djangoldp_account`, `djangoldp_upload`, `django-webidoidc-provider` packages
@ -105,7 +105,7 @@ On `config.json`:
Where:
* `client.name` is the name of your Hubl
* `client.name` is the name of your Orbit
* `client.logo` is an URL to an image file
* `components` is your modules declaration registry
@ -129,7 +129,7 @@ On `config.json`:
Where:
* `client.favicon` is an URL to a distant favicon
* `client.css` is an URL to a distant CSS that'll be the last one loaded by the Hubl
* `client.css` is an URL to a distant CSS that'll be the last one loaded by the Orbit
* `client.i18n.lang` is the fallback langage in case the visitor's browser one does not contain the string
* `client.i18n.force` allows to ignore the visitor's browser langage and force the `client.i18n.lang` one
@ -171,9 +171,9 @@ Eg. to add the `notification` module:
### About
About is a short page about the technology behind Hubl.
About is a short page about the technology behind Orbit.
To activate about on Hubl, add this module declaration your `config.json`:
To activate about on Orbit, add this module declaration your `config.json`:
```json
{
@ -186,7 +186,7 @@ To activate about on Hubl, add this module declaration your `config.json`:
Administration is a minimal modulable admin module for all other ones.
To activate administration on Hubl, add this module declaration your `config.json`:
To activate administration on Orbit, add this module declaration your `config.json`:
```json
{
@ -197,7 +197,7 @@ To activate administration on Hubl, add this module declaration your `config.jso
### Analytics
Hubl support Google or Matomo as analytics trackers. To use them, add to your `config.json`:
Orbit support Google or Matomo as analytics trackers. To use them, add to your `config.json`:
```json
{
@ -277,9 +277,9 @@ Eg.:
### Communities
Communities are an optional layer to add on an Hubl. They add a SOLID representation of one to many group of users on your data server.
Communities are an optional layer to add on an Orbit. They add a SOLID representation of one to many group of users on your data server.
If you're upgrading an existion Hubl, you can assign all your local users to a community this way:
If you're upgrading an existion Orbit, you can assign all your local users to a community this way:
@ -287,7 +287,7 @@ If you're upgrading an existion Hubl, you can assign all your local users to a c
Don't forget to set some users as admin of the community from the Django Admin if you want to allow them to create new users from app.
To activate community on Hubl, add this module declaration your `config.json`:
To activate community on Orbit, add this module declaration your `config.json`:
```json
{
@ -619,7 +619,7 @@ The user registration module allows users to self-register.
Community module is mandatory.
If you set `allow_self_registration` on a community, it'll disable the auto-login feature of Hubl and allow your users to self register on your application.
If you set `allow_self_registration` on a community, it'll disable the auto-login feature of Orbit and allow your users to self register on your application.
To activate it, you need:
@ -645,7 +645,7 @@ Where:
### Theme checker
The [Hubl theme manager](https://cdn.startinblox.com/hubl/theme/) is very handy for customer to easily customize the main colors they want to use.
The [Orbit theme manager](https://cdn.startinblox.com/hubl/theme/) is very handy for customer to easily customize the main colors they want to use.
But developers should verify that their development use those colors to fit the customer wishes.
@ -685,7 +685,7 @@ Module declaration, on `config.json`:
### Route generation
Hubl will, by default, generate an unique route for every of your module. You can customize this route by setting a `route` attribute on your module declaration.
Orbit will, by default, generate an unique route for every of your module. You can customize this route by setting a `route` attribute on your module declaration.
Eg. for the Users Directory:
@ -703,15 +703,15 @@ Eg. for the Users Directory:
Will lead to `http://client.url/directory` as URL to reach the module instead of the default `http://client.url/profileDirectory`.
If you provide no `route`, then Hubl will use the `type` as route view name. If two modules share the same `route`, they'll get suffixed with a random unique id.
If you provide no `route`, then Orbit will use the `type` as route view name. If two modules share the same `route`, they'll get suffixed with a random unique id.
Some module don't need any route to be active, set `route` to `false` so.
Components can get the route of a module with `window.hubl.getRoute('componentName')`.
Components can get the route of a module with `window.orbit.getRoute('componentName')`.
#### Change the default route
By default, Hubl will take a Dashboard as a default route.
By default, Orbit will take a Dashboard as a default route.
You can enforce a component to be the default one by adding `defaultRoute` to its parameters.
Jean-Baptiste Pasquier
1 year ago
