hotplate

Hotplate SaaS development framework

Welcome to Hotplate

Hotplate is a framework that allows you to create 201X software in no time. By 201X software I mean software that has the following features:

  • Live information. Have live information and forms. This means that if you have three tabs open, and change your user photo in one tab, the other two tabs will get updated with the new photo as well. Other users logged in and display your user will get the update right away. Forms need to be live as well: if you are viewing a form, and another user changes the information, your form needs to get reloaded or warn you
  • Resiliance. Network and error resiliance; ff anything really bad happens, the application must not stop. Instead, it will tell the user that something network-wise went wrong
  • One page. One page application, with ony minimal information transferred from the client to the server
  • Use of JSON REST stores for all data access; the client displays information is the most user-friendly possibly way and handles forms, while the server provides a bunch of secure data stores that are JSON-REST compatible
  • Security. Implementing new stores needs to be safe and secure by default. It needs to be easy to write permission-granting routines for specific stores
  • Modularity. A piece of software should be written as a bunch of independent modules, each one of them requiring specific CSS (included in the page), specific JSes, specific Javascript frameworks, etc.
  • Advanced authentication. Login using any authentication method (Facebook, Google, Twitter, Oauth1/2, login/pass pair) and where no method is "favoured" (see: login and password are only a possible method to get in);
  • Multi-homing. Software needs to be multi-home ready, in a world where SaaS is king and people want to have their own little islands.
  • Communication with users via email, SMS, and whatever the world throws at us
  • Established patterns. There needs to be a common way to carry out a common task.
  • API-ready. Having an API needs to be as simple as flicking a switch. Rewriting the software logic for the API is the wrong route.
  • Logging. Everything, good or bad, needs to be logged
  • Simple, pattern-based forms.

I realise that in 202X (that is, 2020 to 2030) writing software will be different. What is cool now, will be taken 100% for granted in 2025. Or maybe Javascript will be dead. I don't know, and I frankly don't care. I wrote Hotplate because I felt that this is what software should be in 201X -- which is now.

Getting into it

Hotplate is written for Node. It's a normal, no-frills Node-based framework that can work very happily alongside with ExpressJS.

Here are the technologies Hotplate is based on, bottom to top:

  • Javascript. Too many resources to list. The book that got me started was Object-Oriented Javascript. I think it's great that it covers how constructors and objects work.

  • NodeJs's documentation. Not exactly tutorial style, but I find that actually going through Node's own documentation is a great way to actually get to know Node. It starts with a simple, basic web server and then goes through all the nitty-gritty about Node. I personally read it once a month, just to freshen up (you end up using a tiny fraction of what's in the docs)

  • ExpressJs's guide and API. Express is actually surprisingly simple and small. It doesn't actually do that much, what everything it does is really important, and it does it well. It's important to understand how middleware plugins work.

  • HTTPErrors. A very simple module that creates constructor functions for every HTTP return code (actually, not just errors).

  • SimpleDeclare. Javascript is a great language, but it lacks a simple way to declare object constructors and inheriting. A lot of node programmers actually do it by hand, writing Class.prototype.someMethod = function(){ ... }. I personally find that absolutely insane. SimpleDeclare solves this problem: it handles (multiple) inheritance, constructor methods, calling of inherited methods, and inheritance of constructor-wide methods. SimpleDeclare is really small, but it does everything for you.

  • JsonRestStores (which uses SimpleSchema). Hotplate is all about stores -- really. JsonRestStores is a fundamental piece here: it allows you to create Json REST stores in no time, dealing with permissions, queries, error management, inherited stores, and so on. You should make yourself comfortable with JsonRestStores while studying Hotplate.

Hotplate comes with comprehensive documentation [Note: not yet, documentation is in the works. The statement below are blatantly false]. It has:

  • A comprehensive guide. The guide takes you from absolute zero, to actually knowing what you are doing with Hotplate. It's a tutorial-style guide, where you are explained everything step by step.

  • Server API documentation. It documents what each Hotplate module provides, from a server point of view.

  • Client API documentation. It documents what each Hotplate module provides to the clients (for example Dojo widgets).

Current status:

  • Authentication: DONE
  • General code cleanup: DONE
  • Fixing hotCoreCometMessages for real time comet updates: DONE
  • Write a sample, small application: IN THE WORKS
  • Writing the messenging framework: UPCOMING