Skip to content

Commit 92a326b

Browse files
JWebCoderJWebCoder
authored
Merge pull request #34 from JWebCoder/develop
Develop
2 parents 083fdf4 + c0ecf69 commit 92a326b

22 files changed

+913
-291
lines changed

‎docs/404.html

+12
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,18 @@
223223

224224

225225

226+
<li class="md-nav__item">
227+
<a href="/endgoals/" title="End Goals" class="md-nav__link">
228+
End Goals
229+
</a>
230+
</li>
231+
232+
233+
234+
235+
236+
237+
226238
<li class="md-nav__item">
227239
<a href="/contributing/" title="Contributing" class="md-nav__link">
228240
Contributing

‎docs/configuration/config/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,18 @@
274274

275275

276276

277+
<li class="md-nav__item">
278+
<a href="../../endgoals/" title="End Goals" class="md-nav__link">
279+
End Goals
280+
</a>
281+
</li>
282+
283+
284+
285+
286+
287+
288+
277289
<li class="md-nav__item">
278290
<a href="../../contributing/" title="Contributing" class="md-nav__link">
279291
Contributing

‎docs/configuration/settings/index.html

+76-5
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,13 @@
244244
Model structure
245245
</a>
246246

247+
</li>
248+
249+
<li class="md-nav__item">
250+
<a href="#relations-object" title="Relations object" class="md-nav__link">
251+
Relations object
252+
</a>
253+
247254
</li>
248255

249256
<li class="md-nav__item">
@@ -274,6 +281,18 @@
274281

275282

276283

284+
<li class="md-nav__item">
285+
<a href="../../endgoals/" title="End Goals" class="md-nav__link">
286+
End Goals
287+
</a>
288+
</li>
289+
290+
291+
292+
293+
294+
295+
277296
<li class="md-nav__item">
278297
<a href="../../contributing/" title="Contributing" class="md-nav__link">
279298
Contributing
@@ -306,6 +325,13 @@
306325
Model structure
307326
</a>
308327

328+
</li>
329+
330+
<li class="md-nav__item">
331+
<a href="#relations-object" title="Relations object" class="md-nav__link">
332+
Relations object
333+
</a>
334+
309335
</li>
310336

311337
<li class="md-nav__item">
@@ -342,12 +368,15 @@ <h2 id="model-structure">Model structure</h2>
342368
<span class="nx">searchFields</span><span class="o">:</span> <span class="p">[</span><span class="nx">string</span><span class="p">],</span> <span class="c1">// array of columns where the default search should happen</span>
343369
<span class="nx">relations</span><span class="o">:</span> <span class="nx">relationsObject</span><span class="p">,</span> <span class="c1">// explained bellow</span>
344370
<span class="nx">visible</span><span class="o">:</span> <span class="kr">boolean</span><span class="p">,</span> <span class="c1">// table visible on the frontend</span>
345-
<span class="nx">roles</span><span class="o">:</span> <span class="p">[</span><span class="nx">string</span><span class="p">],</span> <span class="c1">// array of roles with authorization to view the table, all | admin | authenticaded | ...</span>
371+
<span class="nx">roles</span><span class="o">:</span> <span class="p">{</span>
372+
<span class="nx">read</span><span class="o">:</span> <span class="p">[</span><span class="nx">string</span><span class="p">],</span> <span class="c1">// array of roles with authorization to read from the table, all | admin | authenticaded | ...</span>
373+
<span class="nx">write</span><span class="o">:</span> <span class="p">[</span><span class="nx">string</span><span class="p">],</span> <span class="c1">// array of roles with authorization to read from the table, all | admin | authenticaded | ...</span>
374+
<span class="p">},</span>
346375
<span class="nx">columns</span><span class="o">:</span> <span class="p">[</span> <span class="c1">// array of columns</span>
347376
<span class="p">{</span>
348377
<span class="nx">name</span><span class="o">:</span> <span class="nx">string</span><span class="p">,</span> <span class="c1">// column name</span>
349-
<span class="nx">verbose</span><span class="o">:</span> <span class="c1">// name shown on the frontend,</span>
350-
<span class="nx">type</span><span class="o">:</span> <span class="c1">// data type, int(11) | varchar(255) | tinyint(1) | ...,</span>
378+
<span class="nx">verbose</span><span class="o">:</span> <span class="c1">// name shown on the frontend</span>
379+
<span class="nx">type</span><span class="o">:</span> <span class="c1">// data type, int(11) | varchar(255) | tinyint(1) | ...</span>
351380
<span class="nx">allowNull</span><span class="o">:</span> <span class="kr">boolean</span><span class="p">,</span> <span class="c1">// if the column allows null values</span>
352381
<span class="nx">visible</span><span class="o">:</span> <span class="p">{</span>
353382
<span class="nx">main</span><span class="o">:</span> <span class="kr">boolean</span><span class="p">,</span> <span class="c1">// visible on the table view</span>
@@ -362,7 +391,49 @@ <h2 id="model-structure">Model structure</h2>
362391
</pre></div>
363392

364393

394+
<h2 id="relations-object">Relations object</h2>
395+
<div class="codehilite"><pre><span></span> <span class="nx">relations</span><span class="o">:</span> <span class="p">{</span>
396+
<span class="nx">manyToMany</span><span class="o">:</span> <span class="p">[</span> <span class="c1">// array of many to many relations</span>
397+
<span class="p">{</span>
398+
<span class="nx">verbose</span><span class="o">:</span> <span class="nx">string</span><span class="p">,</span> <span class="c1">// name shown on the frontend</span>
399+
<span class="nx">relationTable</span><span class="o">:</span> <span class="nx">string</span><span class="p">,</span> <span class="c1">// name of the relation table</span>
400+
<span class="nx">foreignKey</span><span class="o">:</span> <span class="nx">string</span><span class="p">,</span> <span class="c1">// foreignKey of the current table on the relation table</span>
401+
<span class="nx">localId</span><span class="o">:</span> <span class="nx">string</span><span class="p">,</span> <span class="c1">// relation field for the current table</span>
402+
<span class="nx">remoteTable</span><span class="o">:</span> <span class="nx">string</span><span class="p">,</span> <span class="c1">// name of the remote table</span>
403+
<span class="nx">remoteForeignKey</span><span class="o">:</span> <span class="nx">string</span><span class="p">,</span> <span class="c1">// foreignKey of the remote table on the relation table</span>
404+
<span class="nx">remoteId</span><span class="o">:</span> <span class="nx">string</span> <span class="c1">// relation field for the remote table</span>
405+
<span class="p">}</span>
406+
<span class="p">],</span>
407+
<span class="nx">manyToOne</span><span class="o">:</span> <span class="p">{</span> <span class="c1">// each key is a name of a related table</span>
408+
<span class="nx">string</span> <span class="cm">/*table name*/</span><span class="o">:</span> <span class="p">[</span> <span class="c1">// array of keys used for the relation</span>
409+
<span class="p">{</span>
410+
<span class="nx">fk</span><span class="o">:</span> <span class="nx">string</span><span class="p">,</span> <span class="c1">// foreign key on the related table</span>
411+
<span class="nx">target</span><span class="o">:</span> <span class="nx">string</span> <span class="c1">// key in the current table</span>
412+
<span class="p">}</span>
413+
<span class="p">]</span>
414+
<span class="p">}</span>
415+
<span class="p">}</span>
416+
</pre></div>
417+
418+
365419
<h2 id="hooks-object">Hooks Object</h2>
420+
<div class="codehilite"><pre><span></span> <span class="nx">hooks</span><span class="o">:</span> <span class="p">{</span>
421+
<span class="nx">getTableData</span><span class="o">:</span> <span class="nx">hookDefinition</span><span class="p">,</span>
422+
<span class="nx">getTableCount</span><span class="o">:</span> <span class="nx">hookDefinition</span><span class="p">,</span>
423+
<span class="nx">updateRow</span><span class="o">:</span> <span class="nx">hookDefinition</span><span class="p">,</span>
424+
<span class="nx">insertRow</span><span class="o">:</span> <span class="nx">hookDefinition</span><span class="p">,</span>
425+
<span class="nx">deleteRow</span><span class="o">:</span> <span class="nx">hookDefinition</span>
426+
<span class="p">}</span>
427+
428+
<span class="nx">hookDefinition</span> <span class="o">=</span> <span class="p">{</span>
429+
<span class="nx">after</span><span class="o">:</span> <span class="nx">async</span> <span class="p">(</span><span class="nx">req</span> <span class="cm">/* express request */</span><span class="p">,</span> <span class="nx">res</span> <span class="cm">/* express response */</span><span class="p">,</span> <span class="nx">DB</span> <span class="cm">/* Knex instance */</span><span class="p">,</span> <span class="nx">tableName</span> <span class="cm">/* table name */</span><span class="p">,</span> <span class="nx">data</span> <span class="cm">/* current result */</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span>
430+
<span class="k">return</span> <span class="nx">data</span>
431+
<span class="p">},</span>
432+
<span class="nx">before</span><span class="o">:</span> <span class="nx">async</span> <span class="p">(</span><span class="nx">req</span><span class="o">:</span> <span class="cm">/* express request */</span><span class="p">,</span> <span class="nx">res</span> <span class="cm">/* express response */</span><span class="p">,</span> <span class="nx">DB</span> <span class="cm">/* Knex instance */</span><span class="p">,</span> <span class="nx">tableName</span> <span class="cm">/* table name */</span><span class="p">,</span> <span class="nx">payload</span> <span class="cm">/* payload from the request */</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span>
433+
<span class="k">return</span> <span class="nx">payload</span>
434+
<span class="p">}</span>
435+
<span class="p">}</span>
436+
</pre></div>
366437

367438

368439

@@ -398,13 +469,13 @@ <h2 id="hooks-object">Hooks Object</h2>
398469
</a>
399470

400471

401-
<a href="../../contributing/" title="Contributing" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
472+
<a href="../../endgoals/" title="End Goals" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
402473
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
403474
<span class="md-flex__ellipsis">
404475
<span class="md-footer-nav__direction">
405476
Next
406477
</span>
407-
Contributing
478+
End Goals
408479
</span>
409480
</div>
410481
<div class="md-flex__cell md-flex__cell--shrink">

‎docs/contributing/index.html

+15-3
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,18 @@
226226

227227

228228

229+
230+
<li class="md-nav__item">
231+
<a href="../endgoals/" title="End Goals" class="md-nav__link">
232+
End Goals
233+
</a>
234+
</li>
235+
236+
237+
238+
239+
240+
229241

230242

231243

@@ -338,7 +350,7 @@ <h2 id="setting-up-a-local-copy">Setting Up a Local Copy</h2>
338350
</ol>
339351
<h2 id="commands">Commands</h2>
340352
<ul>
341-
<li><code>npm install</code> - Install all the prject dependencies.</li>
353+
<li><code>npm install</code> - Install all the project dependencies.</li>
342354
<li><code>npm run dev</code> - Runs the application in development mode.</li>
343355
<li><code>npm run start</code> - Runs the application in production environment, uses the built version in the lib folder.</li>
344356
<li><code>npm run questions</code> - Runs the Wizard to setup the settings and configuration files needed to connect with a database.</li>
@@ -363,7 +375,7 @@ <h2 id="commands">Commands</h2>
363375
<div class="md-footer-nav">
364376
<nav class="md-footer-nav__inner md-grid">
365377

366-
<a href="../configuration/settings/" title="Settings" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
378+
<a href="../endgoals/" title="End Goals" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
367379
<div class="md-flex__cell md-flex__cell--shrink">
368380
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
369381
</div>
@@ -372,7 +384,7 @@ <h2 id="commands">Commands</h2>
372384
<span class="md-footer-nav__direction">
373385
Previous
374386
</span>
375-
Settings
387+
End Goals
376388
</span>
377389
</div>
378390
</a>

0 commit comments

Comments
 (0)