Webb Framework

Written by Cosmin Apreutesei. Public Domain.

Install

Download & build openresty

./build-openresty

Reset MySQL root password

sudo mysql -u root

DROP USER 'root'@'localhost';
CREATE USER 'root'@'%' IDENTIFIED BY '';
GRANT ALL PRIVILEGES ON *.* TO 'root'@'%';
FLUSH PRIVILEGES;

Dependency versions

resty.session     1.1    (included; current is 2.18)
resty.socket      ?      (included; current is 0.0.7)

jQuery            3.2.1  (included)
jquery.history    1.8b2  (included)
mustache.js       2.3.0  (included)

lustache.lua      1.3.1  (included)
lp.lua            1.15   (included; current is ?)

Extra modules

jquery.validate   1.17.0 (included)
jquery.easing     1.3    (included)
content-tools		1.5.4  (included)
normalize.css     7.0.0  (included)

HowTO

Here's a very basic website sketch that uses some webb features.

Create a file nginx-server.conf and type in it:

listen 127.0.0.1:8882;
set $main_module "main";   # runs main.lua for every url
set $hide_errors true;     # hide errors when crashing

Type ./ngx-start then check http://127.0.0.1:8882.

You should get a 500 error because main.lua (our main file) is missing.

main.lua

require'webbjs'    -- required, obviously
require'query'     -- if using mysql
require'sendmail'  -- if sending mail
require'session'   -- if needing session tracking and/or user accounts
require'config'    -- config.lua, see below
require'secrets'   -- secrets.lua file, see below


cssfile[[
	font-awesome.css    --if using font awesome
	jquery.toasty.css   --if using toasty
]]

jsfile[[
	jquery.toasty.js    --if using toasty notifications
	jquery.easing.js    --if using easing transitions
	jquery.validate.js  --if using client-side validation
	jquery.unslider.js  --if using unslider
	analytics.js        --if using analytics
	facebook.js         --if using facebook authentication
	google.js           --if using g+ authentication
	account.js          --if using the standard account widget TODO
	resetpass.js        --if using the sandard reset password widget TODO
	config.js           --auto-generated with some values from config.lua
]]

return function()  --called for every URL. make your routing strategy here.
	touch_usr() --update usr.atime on all requests, except image requests.
	check(action(find_action(unpack(args()))))
end

config.lua

Note: only need to add the lines for which the value is different than below.

config('lang', 'en')              --the default language

config('root_action', 'home')     --the action to run for the '/' path
config('templates_action', '_templates')
config('404_html_action', '404.html')
config('404_png_action', '404.png')
config('404_jpeg_action', '404.jpg')

config('db_host', '127.0.0.1')    --the ip address of the local mysql server
config('db_port', 3306)           --the port of the local mysql server
config('db_name', '<db name>')    --the mysql database name
config('db_user', 'root')         --the mysql user
config('db_conn_timeout', 3)      --connection timeout in seconds
config('db_query_timeout', 30)    --query timeout in seconds

config('pass_token_lifetime', 3600) --remember-password token lifetime
config('pass_token_maxcount', 2)  --max remember-password tokens allowed

config('smtp_host', '127.0.0.1')  --the ip address of the local smtp server
config('smtp_port', 25)           --the port address of the local smtp server

config('facebook_app_id',  '<fb app id>')         --fb app id for fb authentication
config('google_client_id', '<google client id>')  --google client id for g+ authentication
config('analytics_ua',     '<analytics UA code>') --google analytics UA code for analytics

secrets.lua, not to be added to git

config('pass_salt',      '<any random string>') --for encrypting passwords in the database
config('session_secret', '<any random string>') --for encrypting cookies
config('db_pass',        nil)                   --the mysql password

Modules

webb.lua main module action.lua routing module query.lua mysql query module ddl.lua ddl macros session.lua session and authentication module sendmail.lua sending emails webbjs.lua webb.js support module

webb.js client-side main module webb.ajax.js ajax module

webb.timeago.js time formatting webb.util.js misc. webb.back-to-top.js back-to-top button webb.content-tools.js contenteditable library