WebPageToCCode

TLDR;

A tool for generating C-Code out of a website to be used to compile it into ESP8266 or ESP32 based projects.

What does it do?

This tool can take an output directory of a modern webframework like Angular or React and recursivly map all files into a C header and source file. Both files are human readable formatted and contain an copyright string on top. Afterwords it uses the popular Arduino Webserver library to register all files by it's file positions and create a callback functions for it.

Why the project is useful?

The main goal is to split and automate the process of creating a modern website using popular frameworks and easily map it into an ESP Firmware without worry about all the fancy web stuff like Media Types, Compression Minfying...

How to use the tool?

Install

To use it within your package.json as script, just install it as DevDependency

  npm install -D webpagetoccode

If you plan to use it as a general tool of choice it is recommended to install it globally

  npm install -g webpagetoccode

Usage

To use it as script inside your package.json.

For example within an React Project:

  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject",
    "postbuild": "precompress -t gz -i html,js,json,css,txt build && webpagetoccode -s build -t ../target"
  }

Or to use it as generall tool simply put

> webpagetoccode -h

Options:
      --version  Show the package version                               [boolean]
  -s, --source   Sets the root directory containing the website.
                                                              [string] [required]
  -t, --target   Sets the target directory where the output is generated.       
                                                        [string] [default: "lib"]
  -a, --author   Adds the author to the source code files as requierd by cpplint.
                                                    [string] [default: "unknown"]
  -h, --help     Show this message                                      [boolean]

The minimal usage is as follows

webpagetoccode --source <RootDirectory>

NOTE

The tool checks for files which are compressed as gz. You can leave the compressed and none-compressed files side by side and the tool takes only the compressed files wherever possible.

How does it looks like?

The Tool generates to files website.h and websites.cpp. The first one website.h just declare the Webserver as extern dependency and publishes the registerWebsite() function. The second file website.cpp contains all the stuff.

To include the website just copy both generated files into your Arduino / CPP project and #include "website.h". After you setup your Webserver call registerWebsite() - That's it.

#include <Webserver.h>
#include "website.h"

WebServer server(80);

void setup(){
  registerWebsite();
  server.begin();
}

void loop(){
  server.handleClient();
}

NOTE

If the tool finds an index.html file in your root directory, it automatically addes a default route "/" to serve this file.

Regardless if it`s a compressed file or not.