Skip to content
Snippets Groups Projects
get-started.rst 2.36 KiB
Newer Older
Alice Poggioli's avatar
Alice Poggioli committed
Get Started
Alice Poggioli's avatar
Alice Poggioli committed
###########
Alice Poggioli's avatar
Alice Poggioli committed

Alice Poggioli's avatar
Alice Poggioli committed
Startin'blox is a front framework based on `Web Components <https://www.webcomponents.org/>`__ and `Linked Data conventions <https://www.w3.org/standards/semanticweb/data/>`__ to create interfaces compatible with the `SOLID specifications <https://github.com/solid/solid-spec/>`__.
Alice Poggioli's avatar
Alice Poggioli committed

Alice Poggioli's avatar
Alice Poggioli committed
=> To know more about Startin'blox, have a look to `our website <https://startinblox.com/>`__.
Alice Poggioli's avatar
Alice Poggioli committed


Alice Poggioli's avatar
Alice Poggioli committed
Hello Word
-----------

The simplest code you can try with SiB look like this : 

.. code:: html

   <sib-display data-src="https://api.startinblox.com/helloworlds/" fields="helloword"></sib-display

sib-display is one of the main component of the framework that display fields of a data source.
Our data sources are formatted with JsonLD. 

=> `Why JsonLD ? <Solid-introduction/>`__

Have a look on how our datas are structured :  `https://api.startinblox.com/helloworlds/ <https://api.startinblox.com/helloworlds/>`__
Alice Poggioli's avatar
Alice Poggioli committed


Play with Startin'blox
......................

To try the framework, you can play with 
Alice Poggioli's avatar
Alice Poggioli committed
=> `our demo <https://startinblox.com/fr/technology#demo/>`__.
=> `our SiB builder <https://la-pommeraye.fr/sib-builder/#startinblox/core@latest/>`__.


Use Startin'blox
----------------

Startin'blox was designed to be modular. You can integrate only one component to an existing application or build an entire application in SiB. You are not supposed to master javascript to use the framework but as we are still in development, it is advisable to have some notions

Alice Poggioli's avatar
Alice Poggioli committed


Add a SiB components to a website
.................................

You can easily and quickly add a component to an existing application juste adding a script and a tag. We are currently working on making integration even easier with WordPress plugins.

=> `How to integrate a component ? <Use-a-component-alone-in-an-existing-application/>`__


Build an application with SiB
.................................

You'll find in the framework everything you need to build an entiere application. To start a project in SiB, you just need a simple HTML file, add framework scripts and put tags. 

=> `How to build a full application ? <build-full-application/>`__

Alice Poggioli's avatar
Alice Poggioli committed
Glossary
Alice Poggioli's avatar
Alice Poggioli committed
........

The glossary contains an overview of the most commonly used terms in the documentation. 

Alice Poggioli's avatar
Alice Poggioli committed
=> `Have a look on the glossary <Glossary/>`__
Alice Poggioli's avatar
Alice Poggioli committed


Alice Poggioli's avatar
Alice Poggioli committed
Something is missing ? 
Alice Poggioli's avatar
Alice Poggioli committed
-----------------------
Alice Poggioli's avatar
Alice Poggioli committed

`Let's us know <https://mailto:alice@startinblox.com/>`__ !