-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
77 lines (46 loc) · 8.13 KB
/
index.html
File metadata and controls
77 lines (46 loc) · 8.13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Home - WebSuite Dokumentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">WebSuite Dokumentation</a></h2><h3>Klassen</h3><ul><li><a href="Cronjob.html">Cronjob</a><ul class='methods'><li data-type='method'><a href="Cronjob.html#registerJob">registerJob</a></li></ul></li><li><a href="CryptoUtil.html">CryptoUtil</a><ul class='methods'><li data-type='method'><a href="CryptoUtil.html#.hash">hash</a></li><li data-type='method'><a href="CryptoUtil.html#.verify">verify</a></li></ul></li><li><a href="Database.html">Database</a><ul class='methods'><li data-type='method'><a href="Database.html#query">query</a></li></ul></li><li><a href="EventHandler.html">EventHandler</a><ul class='methods'><li data-type='method'><a href="EventHandler.html#emit">emit</a></li><li data-type='method'><a href="EventHandler.html#on">on</a></li></ul></li><li><a href="FileUtil.html">FileUtil</a><ul class='methods'><li data-type='method'><a href="FileUtil.html#.fileExists">fileExists</a></li><li data-type='method'><a href="FileUtil.html#.readFile">readFile</a></li><li data-type='method'><a href="FileUtil.html#.saveFile">saveFile</a></li></ul></li><li><a href="Logger.html">Logger</a><ul class='methods'><li data-type='method'><a href="Logger.html#debug">debug</a></li><li data-type='method'><a href="Logger.html#error">error</a></li><li data-type='method'><a href="Logger.html#info">info</a></li><li data-type='method'><a href="Logger.html#warn">warn</a></li></ul></li><li><a href="Mail.html">Mail</a></li><li><a href="Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="Sessions.html#getUserID">getUserID</a></li><li data-type='method'><a href="Sessions.html#getUserSessions">getUserSessions</a></li></ul></li><li><a href="TimeUtil.html">TimeUtil</a><ul class='methods'><li data-type='method'><a href="TimeUtil.html#.currentTime">currentTime</a></li><li data-type='method'><a href="TimeUtil.html#.futureTime">futureTime</a></li><li data-type='method'><a href="TimeUtil.html#.pastTime">pastTime</a></li></ul></li><li><a href="UserHandler.html">UserHandler</a><ul class='methods'><li data-type='method'><a href="UserHandler.html#getUserByEMail">getUserByEMail</a></li><li data-type='method'><a href="UserHandler.html#getUserByUserID">getUserByUserID</a></li><li data-type='method'><a href="UserHandler.html#getUserByUserName">getUserByUserName</a></li></ul></li><li><a href="UserUtil.html">UserUtil</a><ul class='methods'><li data-type='method'><a href="UserUtil.html#.emailAvailable">emailAvailable</a></li><li data-type='method'><a href="UserUtil.html#.emailValid">emailValid</a></li><li data-type='method'><a href="UserUtil.html#.usernameAvailable">usernameAvailable</a></li><li data-type='method'><a href="UserUtil.html#.usernameValid">usernameValid</a></li></ul></li><li><a href="WebSocketHandler.html">WebSocketHandler</a><ul class='methods'><li data-type='method'><a href="WebSocketHandler.html#registerCpEvent">registerCpEvent</a></li><li data-type='method'><a href="WebSocketHandler.html#registerEvent">registerEvent</a></li><li data-type='method'><a href="WebSocketHandler.html#sendToClient">sendToClient</a></li></ul></li><li><a href="WebSuite.html">WebSuite</a><ul class='methods'><li data-type='method'><a href="WebSuite.html#getCrons">getCrons</a></li><li data-type='method'><a href="WebSuite.html#getDatabase">getDatabase</a></li><li data-type='method'><a href="WebSuite.html#getEventHandler">getEventHandler</a></li><li data-type='method'><a href="WebSuite.html#getLogger">getLogger</a></li><li data-type='method'><a href="WebSuite.html#getMail">getMail</a></li><li data-type='method'><a href="WebSuite.html#getSessions">getSessions</a></li><li data-type='method'><a href="WebSuite.html#getUserHandler">getUserHandler</a></li><li data-type='method'><a href="WebSuite.html#getWebSocketHandler">getWebSocketHandler</a></li></ul></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-getting-started.html">Einführung in die Entwicklung</a></li><li><a href="tutorial-password-hashing-argon2.html">Argon2 als Passwort-Hashing-Algorithmus</a></li></ul>
</nav>
<div id="main">
<section class="readme">
<article><p><a href="https://www.codacy.com/app/ilouHD/WebSuite-Core?utm_source=github.com&utm_medium=referral&utm_content=NodeLabIT/WebSuite-Core&utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/05dfdb44e89241e58d7c7f4a779c6eef" alt="Codacy Badge"></a> <a href="https://travis-ci.org/NodeLabIT/WebSuite-Core"><img src="https://travis-ci.org/NodeLabIT/WebSuite-Core.svg?branch=development" alt="Build Status"></a> <a href="https://github.com/NodeLabIT/WebSuite-Core"><img src="https://img.shields.io/badge/dynamic/json.svg?label=WebSuite-Core&url=https%3A%2F%2Fraw.githubusercontent.com%2FNodeLabIT%2FWebSuite-Core%2Fdevelopment%2Fpackage.json&query=version&colorB=blue" alt="Version"></a></p>
<h1>WebSuite</h1><p>Die WebSuite ist ein Content-Management-System mit neuester Technik. Die Verbindung von Node.js, socket.io und Vue.js sorgt dabei für ein modernes System, das eine unvergleichbare Einzigartigkeit und Interaktion bietet, wie sie bisher kein CMS erreichen konnte. Inhalte können somit schnell und Live aktualisiert werden und auch erreichen wir mit Vue.js die Möglichkeit auf eine Single-Page-Application.</p>
<p>Allgemein bietet die WebSuite einen Core, über den sich vielerlei Plugins umsetzen lassen, wodurch die WebSuite auch mit vielen Plugins erweiterbar ist.</p>
<h1>WebSuite Core</h1><p>Der Core ist das Heiligtum der gesamten Software und stellt somit den Kern der gesamten Anwendung dar. Der Core beinhaltet alle wichtigen Funktionen und dient als Schnittstelle für Entwickler. Er stellt dabei alle für Entwickler relevanten Funktionen wie z.B. die Anbindung an Datenbanken, Anbindung an den Mailserver, Socketserver, sowie verschiedene andere Nützlichkeiten (Utils) bereit.</p>
<p>Neben den genannten Funktionen für Entwickler, verfügt der Core über Funktionen zur einfachen Bedienbarkeit der Anwendung. Dazu gehört insbesondere das Control Panel, das die einfache Bedienbarkeit der gesamten Anwendung unterstützt und viele Einstellungsmöglichkeiten bietet.</p>
<p>Der Core generell wird im Clusterbetrieb laufen. So ist es einfach im laufenden Betrieb das System neuzustarten, ohne, dass der Nutzer davon etwas mitbekommt. Ebenfalls kann so garantiert werden, dass im Falle eines Fehlers, ein "Subsystem" vernünftig den Fehler loggen und sich neustarten kann.</p>
<h1>Discord</h1><p>Du möchtest über alles informiert werden? Dann trete noch heute unserem Discord-Server bei: https://discord.gg/AmBnFbA</p>
<h1>Milestones</h1><p>Alle Milestones des Projektes sind hier einsehbar: https://github.com/NodeLabIT/WebSuite-Core/milestones</p>
<h1>JSDocs</h1><p>JSDocs können mit <code>jsdoc -c jsdoc.json</code> generiert werden. Dazu muss <code>jsdoc</code> global als depencdency installiert sein.
Weiterhin muss das <a href="https://github.com/NodeLabIT/JSDoc-Theme">NodeLab-Theme für JSDoc</a> relativ zur <code>jsdoc.json</code> gesehen im Ordner <code>../JSDoc-Theme/</code> liegen.</p></article>
</section>
</div>
<br class="clear">
<footer>
Seite zuletzt am 18.11.2018 um 00:27 Uhr generiert
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>