| name | usage |
|---|---|
| Attribute New Line | Every attribute a separate line (if only one exists it can be on the same line) |
| Initial Indent | ✅ |
| name | usage |
|---|---|
| Initial Indent | ✅ |
| name | usage |
|---|---|
| Attribute New Line | Every attribute a separate line (if only one exists it can be on the same line) |
| Initial Indent | ✅ |
| name | usage |
|---|---|
| API Style | Composition API without the 'script setup' code block. |
| Component Names | Pascal Case |
| name | usage |
|---|---|
| Controllers | Slim Controllers -> Logic should be inside models Control only handles the Requests |
| Models | If we need additional functionality, it shoudl reside inside the model, not the controller, as it can be easily reused inside different controllers but still be in it's associated model. |
| Component Names | Pascal Case |
<script>
+ import {reactive} from vue
+ import MyComponent from "@/components/MyComponent"
+
+ export default {
+ components: { MyComponent },
+ setup(props){
+
+ const state = reactive({
+ active: false,
+ })
+
+
+ return {
+ state
+ }
+ }
+ }
+</script>
+This documentation is based on VuePress, a vue-powered static site generator. Here you get a brief overview on how to contribute to the growth and the maintainance of this documentation. The underlying repository is located in GitHub.
There are only a few places of relevance for the average contributor: pages, assets and the config.
All pages are written in plain Markdown. If you want to change a file, just locate it inside the /docs/ directory and add the file accordingly. There are some additional Markdown functionalities available. For a more detailed description see the VuePress Documentation.
If you want to add a page, you also need to register that file inside the sidebar section of the config file. For it to show up in the navigation.
That's basically it. Thank you for contributing.
',10)]))}const c=t(a,[["render",i],["__file","docs.html.vue"]]),d=JSON.parse('{"path":"/development/docs.html","title":"Documentation","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"Structure","slug":"structure","link":"#structure","children":[]},{"level":2,"title":"Contributing","slug":"contributing","link":"#contributing","children":[]},{"level":2,"title":"Final Notes","slug":"final-notes","link":"#final-notes","children":[]}],"git":{"updatedTime":1727867972000,"contributors":[{"name":"Severino","email":"severin.opel@hotmail.com","commits":1}]},"filePathRelative":"development/docs.md"}');export{c as comp,d as data}; diff --git a/assets/guide.html-KZXxI4DS.js b/assets/guide.html-KZXxI4DS.js new file mode 100644 index 0000000..1517597 --- /dev/null +++ b/assets/guide.html-KZXxI4DS.js @@ -0,0 +1 @@ +import{_ as r,c as t,a as e,o as i}from"./app-KSWfRAhX.js";const o={};function n(s,a){return i(),t("div",null,a[0]||(a[0]=[e("h1",{id:"user-guide",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#user-guide"},[e("span",null,"User Guide")])],-1),e("p",null,"Here will be more informations for Spacialist users soon.",-1),e("h1",{id:"data-importer",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#data-importer"},[e("span",null,"Data Importer")])],-1),e("p",null,"Here you find informations about the data importer",-1)]))}const d=r(o,[["render",n],["__file","guide.html.vue"]]),u=JSON.parse('{"path":"/user/guide.html","title":"User Guide","lang":"en-US","frontmatter":{},"headers":[],"git":{"updatedTime":1727867972000,"contributors":[{"name":"Severino","email":"severin.opel@hotmail.com","commits":1}]},"filePathRelative":"user/guide.md"}');export{d as comp,u as data}; diff --git a/assets/index.html-Cr79dq0H.js b/assets/index.html-Cr79dq0H.js new file mode 100644 index 0000000..b2ef320 --- /dev/null +++ b/assets/index.html-Cr79dq0H.js @@ -0,0 +1 @@ +import{_ as e,c as t,o as i}from"./app-KSWfRAhX.js";const o={};function a(s,n){return i(),t("div")}const r=e(o,[["render",a],["__file","index.html.vue"]]),c=JSON.parse('{"path":"/","title":"Home","lang":"en-US","frontmatter":{"home":true,"title":"Home","heroImage":"./images/spacialist_logo_lines_black.svg","heroImageDark":"./images/spacialist_logo_lines_white.svg","actions":[{"text":"User Guide","link":"/user/guide.html","type":"primary"},{"text":"Coding Guide","link":"/development/coding-style.html","type":"primary"}],"features":[{"title":"User Guide","details":"Enduser of the Spacialist Software can find useful resources to unlock the full potential of this versatile work environment."},{"title":"Plugins","details":"Spacialist is build to be easily extensible and adjustable to the project needs. Existing Plugins can be added easily to give a tailored set of features and also provide developers an easy way to extend the software without having to change core functionality."},{"title":"Coding Guide","details":"Developers can look up the coding philosophy we are using in the project when contributing to the project."}],"footer":"MIT Licensed | Copyright © 2024"},"headers":[],"git":{"updatedTime":1727867972000,"contributors":[{"name":"Severino","email":"severin.opel@hotmail.com","commits":3}]},"filePathRelative":"README.md"}');export{r as comp,c as data}; diff --git a/assets/plugins.html-BDXVlf8B.js b/assets/plugins.html-BDXVlf8B.js new file mode 100644 index 0000000..73c514b --- /dev/null +++ b/assets/plugins.html-BDXVlf8B.js @@ -0,0 +1 @@ +import{_ as i,c as e,b as n,o as t}from"./app-KSWfRAhX.js";const a={};function s(o,l){return t(),e("div",null,l[0]||(l[0]=[n('Plugins provide users and developers the ability to have a modular system of extending the functionality of the spacialist software without the need of having all functionality in one gigantic application.
Upload > Install > Activate >< Deactivate < Uninstall < Remove
* required
Plugins can be hooked to a variety of locations of the Spacialist.