doc/design_document_v1.0 from JamesonNetworks/Nirodha

doc/design_document_v1.0
Summary

Maintainability

Test Coverage

Issues
Design Document for Nirodha


Goal: Create a management program for managing views in a web app with HTML, CSS, and Javascript

Commands:

start <port>

    host the thtml view templates in the root of the nirohda folder, recompiling on each request, default to port 8080

deploy 

    compile the thtml file, minify all of the js libraries and css, and deploy to this structure:

create {name}

    creates the root folder structure for a Nirodha project, with a default index.thtml view

create view <template>.vtmp

    creates a Nirodha 'view,' which is the main html component of a nirodha project

Folder structure:

Folder: {view_id}

Symlinks to Nirodha folders:
{view_id}/thirdparty/{name}/
{view_id}/shared/{name}/
{view_id}/shared/templates/

Actual folders for any custom stuff:
{view_id}/custom/js/
{view_id}/custom/css/
{view_id}/custom/templates/
{view_id}/{view_id}.thtml

deploy/js
deploy/css
deploy/

thtml structure:
<!DOCTYPE html>
<html>
<head>
    #sect:includes
    exampleLib1
    exampleLib2
    #endsect
</head>
<body>

<h1>My First Heading</h1>

<p>My first paragraph.</p>

</body>

    #sect:templates
    template1.html
    #endsect

</html>

Renders to:
<!DOCTYPE html>
<html>
<head>

<script src="js/{view_id}.js"></script>
<link rel="stylesheet" type="text/css" href="css/{view_id}.css">

</head>
<body>

<h1>My First Heading</h1>

<p>My first paragraph.</p>

</body>


<script id="template1" type="text/plain">
    {Contents of the template file}
</script>

</html>

js/{view_id}.js
css/{view_id}.css
{view_id}.html