LeanWeb is a minimal hybrid static / dynamic web framework.
LeanWeb is a very lean MVC framework on top of Rack and Tilt that works for static and dynamic content alike. The idea is to build static websites first, but not having to rely on dirty tricks for adding dynamism when needed.
LeanWeb supports every filetype that Tilt supports, when file extension is unknown text will be treated as ERB. Default installation adds HAML as dependency, but you can remove it from the Gemfile.
Great support for Org mode files can be achieved by installing the tilt-emacs_org gem. Notice that it requires Emacs installed.
Developing with LeanWeb
leanweb gem on your system.
Create a new project with
leanweb new <project-directory>.
You're ready to go!
- Place your static files on
- Place your controllers on
- Place your views on
- Setup your routes on
routes.rb, check API documentation to know how
- Setup your Rack middleware on
You can run a development server with
You can setup easily for production or development on a Debian machine with the
API documentation is in YARD, you can access a web version on
https://leanweb.hacktivista.org. Specially relevant are docs on
LEANWEB_ENDPOINT: Website endpoint, could be useful for emails and Hawese, not used by default.
LEANWEB_ROOT_PATH: Defines the route to the project, defaults to current directory.
RACK_ENV: If set to
development, serves static files and routes too, else it will only serve dynamic routes.
Implements payments through a Hawese payment instance.
HAWESE_RETURN_URL: defaults to
SMTP_HOST: Where to connect to.
SMTP_PORT: Port, optional (default: 25).
starttls, otherwise no encryption, optional.
SMTP_USER: User, optional.
SMTP_PASSWORD: Password, optional.
SMTP_FROM: In the format
Build static files with
rake build_static. This might be all you need to do
for static websites.
If your website has dynamic routes, serve with
rackup -E deployment. Then
configure your webserver to serve dynamic routes by listening to port
static files on
Source code is available on https://git.hacktivista.org/leanweb.
Bug reports and patches are welcome on https://lists.hacktivista.org/hacktivista-dev.
Only tested contributions are accepted.
Run fast tests with
rake test. Run all tests with
Source based installation
rake install or
Currently using a 0.x.y versioning, where:
- x: Introduces breaking changes.
- y: Introduces non-breaking changes.
Once this project reaches version 1 it will follow Semantic Versioning 2.0.0.
LeanWeb is libre software released under the GNU Affero General Public License version 3 only. It includes "additional permissions" to make it compatible with a couple of experimental licenses. For more information, refer to the end of the COPYING file.
To comply with license terms, if you modify this software you must prominently provide the means to access the source code of your version of the software easily and free of charge to any person that has access to it, even users which access through a network (i.e. web browser).
Any modification or inclusion of this source code will inherit the same license terms.