Skip to content
Snippets Groups Projects
get-started.rst 1.76 KiB
Newer Older
Alice Poggioli's avatar
Alice Poggioli committed
Getting Started
****************
Alice Poggioli's avatar
Alice Poggioli committed

Alice Poggioli's avatar
Alice Poggioli committed
With the Front
==============
Alice Poggioli's avatar
Alice Poggioli committed

Alice Poggioli's avatar
Alice Poggioli committed
To start, simply import the core in your head tag of a simple html file :

Alice Poggioli's avatar
Alice Poggioli committed
.. code-block:: html

Alice Poggioli's avatar
Alice Poggioli committed
      <!-- ... Import the core ... -->
      <script type="module" src="https://unpkg.com/@startinblox/core"></script>
   </head>

It enables you to use Startin’blox technology and all the main components from the core of the framework.

Alice Poggioli's avatar
Alice Poggioli committed
Jump to the `demonstration <https://docs.startinblox.com/import_documentation/sib-demo.html#demonstration
>`__ to go forward ! 

Alice Poggioli's avatar
Alice Poggioli committed

With the back
=============

Since our frontend framework reads RDF, we adapted a Django server to handle linked datas, which gave birth to DjangoLDP.

.. warning:: if you using Windows, you may get some trouble. Please help us to improve reporting your problem on `this issue <https://git.startinblox.com/documentation/doc/issues/11/>`__



Alice Poggioli's avatar
Alice Poggioli committed
1. Make sure you have the latest version of python 3.6.8 installed.
Alice Poggioli's avatar
Alice Poggioli committed

2. Install ``sib-manager`` that allow you to use the sib command.

Alice Poggioli's avatar
Alice Poggioli committed
.. code-block:: bash 
Alice Poggioli's avatar
Alice Poggioli committed

   python -m pip install -U sib-manager
Alice Poggioli's avatar
Alice Poggioli committed

3. Create your server structure

Alice Poggioli's avatar
Alice Poggioli committed
.. code-block:: bash 
Alice Poggioli's avatar
Alice Poggioli committed

   sib startproject sibserver 
   cd sibserver
   sib install server
Alice Poggioli's avatar
Alice Poggioli committed

Alice Poggioli's avatar
Alice Poggioli committed

That's it. You're almost ready to start :)

Alice Poggioli's avatar
Alice Poggioli committed
Jump to the `demonstration <https://docs.startinblox.com/import_documentation/sib-demo.html#demonstration
>`__ to go forward ! 

Alice Poggioli's avatar
Alice Poggioli committed

Alice Poggioli's avatar
Alice Poggioli committed
Glossary
=============
Alice Poggioli's avatar
Alice Poggioli committed

To be sure to speak the same language throughout the documentation,
you’ll find any tricky vocabulary on this graphic glossary.
Alice Poggioli's avatar
Alice Poggioli committed

.. figure:: ../_static/images/import_documentation/uploads/93e59fc5d2a1a8e2b1a87ec6428c9ca5/Glossaire-doc_1.jpg
   :alt: Glossaire-doc_1
Alice Poggioli's avatar
Alice Poggioli committed

   Glossaire-doc_1
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/>`__ !