nulls
v2.12.2
Published
Simple HTML framework for express
Readme
Nulls
Simple HTML framework for express
Installation
npm install nullsStructure
The nulls framework is a wrapper around express.js
and other useful modules with the goal of making the process of
developing websites quicker and easier.
This framework offers a wide range of configuration options while making everything as secure as possible.
- Highly configurable framework
- Very adaptive server-side rendering engine
- Simple dynamic HTML structure
HTML
Writing dynamic HTML was never as easy as with nulls!
The HTML files are being parsed on the server using cheerio,
making DOM modifications simple and intuitive.
nulls adds a couple of custom HTML attributes,
which are parsed on the server and removed completely
on the client. Internal handlers receive the request object
with parsed cookies, and additional arguments if provided.
Since internal handlers are executed directly in the framework, it is super easy to integrate modular logic, and you don't have to learn "yet another rendering language™" - use the all beloved JavaScript.
null-container- replace HTML in the elementnull-list- iterate over something and make a total html out of it; all further handlers will be passed an additional argument: the current item of the iterable; arguments persist to next levels
null-adder- add HTML to the element (useful for SEO in e.g.<head>)null-list- iterate and add
null-data- server-side data retrieval (useful for title and other placeholders)null-api- form (or button) with the parameternull-upload- additional parameter to parse files server-sidenull-access- additional parameter to verify the API endpoint is called with correct permissions (or else Error 403)null-ajax- additional parameter to add client-side processing of an API request
null-attr- handler returns name-value object; the attributes are set on elementnull-if- conditional executionnull-arg- pass an additional argument to all handlers on the element
Example:
root.html
<ul null-list="() => [{ 'v': 46 }, { 'v': 69, }, { 'v': 83 }]" null-adder="#partials/list-item.html">
</ul>
partials/list-item.html
<li null-data>
<script null-data>
const calculate = require("./lib/math.js");
return async (r, s, d) => {
const value = d.v;
return await calculate(value);
};
</script>
</li>Result on the client:
<ul>
<li>1081</li>
<li>2415</li>
<li>3486</li>
</ul>Configuration
Here's a brief overview of all configs
available at creation of a nulls instance.
uploads-falseor a path to the uploads folderuploadLimit-falseor a total limit for one API request with files attachedforceHTTPS- whether to redirect the clients to HTTPSinit- a function which receives the express app- Executed before any logic is added to the app by the framework
- Useful for custom rate-limiting, blacklisting logic etc.
hook- a function which is called on every request except theHEADrequest- Useful for authentication (see the official auth plugin)
nulls- the folder where all HTML files are storedroot- the name of the "root HTML file" relative tonullsstatic-falseor a path to statically served filesport- the local port to host the website- Usually an automatically assigned port by the hosting software
ready- a callback for when the server is up and runningpreprocessor- function to pre-process every single HTML chunkpostprocessor- function to post-process the result as HTMLtextprocessor- function to post-process the result as raw textsrcProviders- lookup for custom source/script providers- Mainly used by plugins
plugins- an array of config modifying functionsdomain- the host name ofnyour website- Used in security options such as CORS and HTTPS redirects
redirects- lookup for HTML redirects- Since the framework uses
sameoriginpolicy, authentication may not work when landing on your website from an external provider
- Since the framework uses
proxies- passed toapp.set('trust proxy', proxies)in order to securely process IP adresses- Useful for reverse proxies such as cloudflared tunnel
publicUploads- serve user-generated content