Skip to content
Snippets Groups Projects
Commit ccf4d10b authored by Alice Poggioli's avatar Alice Poggioli
Browse files

update get stated

parent 522ab68c
No related branches found
No related tags found
1 merge request!44Master to dev
.. _about-our-components:
About our components
######################
**When you should create a component**
*A component is a feature*
A component is an application service that can be re-used by multiple organizations. You can think about it as an atomic functionality that can be picked and added by people with no technical skills.
Developers often build components in order to avoid repeating the same piece of code in multiple places. As a developer, why should you make a component when you can have the same functionality with the same amount of code?
*Because you don't create a component for your technical needs but for the needs of organizations*.
*Our components are* **high level components**. *That is to say that it is close to the human understanding of a functionality*.
Developing with Startin'Blox is an opportunity to shift your perspective regarding who you program for. Instead of thinking just about your own requirements, you're invited to deliver features useful to both your own project and a much broader ecosystem of organizations.
**Example with a FAQ component**
For instance, implementing a collaborative FAQ could be done with little code. Encapsulating them within an FAQ component wouldn't make your code more concise. But it permit you to share the *idea* of a FAQ as a tool of onboarding or knowledge management.
*With components, you share more than code, you share tools for collaboration within and between organizations.*
So, when you develop a new feature, think about who could use it. If it can be useful to others and there's no similar component already available, make a component so that your work will be easily accessed and used by many!
**Other example :**
* An interactive map
* An agenda
* A job board
* A skill directory
......@@ -3,33 +3,8 @@ How to create components
######################
.. note::
**When you should create a component**
*A component is a feature*
If you want to know when it's relevant to create a component go to the :ref:`"About our Components" <About-our-components>` page.
A component is an application service that can be re-used by multiple organizations. You can think about it as an atomic functionality that can be picked and added by people with no technical skills.
Developers often build components in order to avoid repeating the same piece of code in multiple places. As a developer, why should you make a component when you can have the same functionality with the same amount of code?
*Because you don't create a component for your technical needs but for the needs of organizations*.
*Our components are* **high level components**. *That is to say that it is close to the human understanding of a functionality*.
Developing with Startin'Blox is an opportunity to shift your perspective regarding who you program for. Instead of thinking just about your own requirements, you're invited to deliver features useful to both your own project and a much broader ecosystem of organizations.
**Example with a FAQ component**
For instance, implementing a collaborative FAQ could be done with little code. Encapsulating them within an FAQ component wouldn't make your code more concise. But it permit you to share the *idea* of a FAQ as a tool of onboarding or knowledge management.
*With components, you share more than code, you share tools for collaboration within and between organizations.*
So, when you develop a new feature, think about who could use it. If it can be useful to others and there's no similar component already available, make a component so that your work will be easily accessed and used by many!
**Other example :**
* An interactive map
* An agenda
* A job board
* A skill directory
Let's start
=============
......@@ -75,10 +50,7 @@ Let's set up a local development environment for a FAQ component as example.
# Install a server in a developpement environement
npm i -D http-server
<<<<<<< HEAD
=======
Then, at the root of your project create an ``index.html`` file.
>>>>>>> a4f63657c0a77bcca573b919618fe7309e3b7ceb
**3**. Make an npm command available to launch your server
......
.. _faq:
FAQ
****
* **Why didn't you make a Lib React-Solid, use React Admin or React-Solid-SKD from Inrupt?**
React is a component that works only with React.
We make components that can be displayed in any web page in an autonomous way : that's the beauty of web components.
React's store can't fetch resources from several servers.
we would be forced to rewrite it.
* **How to contribute?**
Have a look on our `contribution guidelines <https://git.startinblox.com/framework/sib-core/blob/master/CONTRIBUTING.md>`__.
......
This diff is collapsed.
......@@ -15,7 +15,7 @@ Welcome to Startinblox's documentation
:maxdepth: 2
:caption: How it works
import_documentation/How-to-make-components
import_documentation/About-our-components
import_documentation/install-sib-server
import_documentation/develop-sib-ldp-packages
import_documentation/server-architecture
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment