|
|
|
# Startin'Blox operational documentation
|
|
|
|
|
|
|
|
## Get started with SIB applications
|
|
|
|
`SIB` application capabilities relies on:
|
|
|
|
|
|
|
|
The easiest to start with is to use an existing SIB application and build it with your own configuration.
|
|
|
|
* Servers with `LDP packages` able to serve the data
|
|
|
|
* Clients with `components` able to manipulate the data
|
|
|
|
|
|
|
|
* [How to build an existing SIB application](./build_sib_application)
|
|
|
|
## The SIB servers
|
|
|
|
|
|
|
|
Of course, to fit your needs you can also get your own app.
|
|
|
|
Before deploying any SIB applications you will need SIB servers able to provide all capabilities your application relies on.
|
|
|
|
|
|
|
|
* [How to develop a new SIB application](./develop_sib_application)
|
|
|
|
SIB servers come with packages developed and [maintained by the Startin'Blox team](https://git.happy-dev.fr/startinblox/djangoldp-packages). You can pick up the ones you like or write your own.
|
|
|
|
|
|
|
|
## Deploying SIB application
|
|
|
|
### Install a SIB server
|
|
|
|
|
|
|
|
Before deploying any SIB application you will need SIB servers able to provide all capabilities your application relies on.
|
|
|
|
You can use any servers exposing data as LDP containers. But you will likely setup your own to expose your data to others.
|
|
|
|
|
|
|
|
* [How to setup a SIB server](./install_sib_server)
|
|
|
|
|
|
|
|
The deployment itself can be done manually dropping the application bundle you built or you can go for a automatic deployment.
|
|
|
|
### Develop your own server packages
|
|
|
|
|
|
|
|
LDP packages represent capabilites the server could support. Each may have it's own configuration depending of what mission it fulfills. There is no limit of what a LDP package can do.
|
|
|
|
|
|
|
|
* [How to develop LDP packages](./develop_sib_ldp_packages)
|
|
|
|
|
|
|
|
## The SIB applications
|
|
|
|
|
|
|
|
SIB applications are only HTML code binding together web components to provide all the functionalities the application requires. Each component can connect to multiple LDP servers providing the matching functionality. As for the server packages, some SIB components are developed and [maintained by the Startin'Blox team](https://git.happy-dev.fr/startinblox/components) but you can write your owns.
|
|
|
|
|
|
|
|
* [How to deploy a SIB application](./deploy_sib_application)
|
|
|
|
### Create an app with SIB components
|
|
|
|
|
|
|
|
## Developing your components
|
|
|
|
* [How to develop a SIB application](./develop_sib_application)
|
|
|
|
|
|
|
|
### Developing your own components
|
|
|
|
|
|
|
|
When developing a new SIB application you can use existing components or create your owns.
|
|
|
|
|
|
|
|
* [How to develop SIB components](./develop_sib_components)
|
|
|
|
|
|
|
|
## Developing your LDP packges
|
|
|
|
### Build an existing SIB application
|
|
|
|
|
|
|
|
* [How to develop LDP packages](./develop_sib_ldp_packages)
|
|
|
|
The easiest to start with is to use an existing SIB application and build it with your own configuration.
|
|
|
|
|
|
|
|
* [How to build an existing SIB application](./build_sib_application)
|
|
|
|
|
|
|
|
## SIB with Gitlab CI
|
|
|
|
|
|
|
|
* [How to set up automatic delivery for a SIB application](./setup_continous_delivery_for_sib_application)
|
|
|
|
* [How to set up automatic delivery for NPM](setup_continous_delivery_for_node)
|
|
|
|
* [How to set up automatic delivery for Pypi](setup_continous_delivery_for_python)
|
|
|
|
|
|
|
|
## SIB in docker
|
|
|
|
|
| ... | ... | |
| ... | ... | |
