https://github.com/v79/cantilever

Creating a cloud-first static website generator using AWS servers such as S3 and Lambda. Transforms markdown files into HTML.
https://github.com/v79/cantilever

Last synced: 2 months ago
JSON representation

Creating a cloud-first static website generator using AWS servers such as S3 and Lambda. Transforms markdown files into HTML.

• Host: GitHub
• URL: https://github.com/v79/cantilever
• Owner: v79
• Created: 2023-01-03T16:31:16.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-02T19:38:38.000Z (4 months ago)
• Last Synced: 2024-10-12T02:09:55.091Z (3 months ago)
• Language: Kotlin
• Size: 4.26 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cantilever

An AWS Lambda driven static site generator written in Kotlin. Source `markdown` files will be converted to HTML 

using the [Flexmark-java](https://github.com/vsch/flexmark-java) library, and further processed using [handlebars.

java](https://github.com/jknack/handlebars.java), in AWS Lambda functions triggered by PUT events on a source S3 

bucket.

The resultant HTML will be written to a separate S3 bucket, configured as a static website.

I haven't quite worked out how to handle site navigation / internal links, but my current thinking is this will be 

fully browser-rendered in javascript, based on a generated site map file (or database?).

Longer term, I'd like to build several interfaces to creating and editing the markdown files, including a website 

and an Android phone app.

## Technology

I will be using AWS Cloudformation and the CDK to build this project. Although this ties me to AWS as a Cloud 

provider, I'm largely OK with that limitation.

I am writing primarily in Kotlin as it is my language of choice. I know that JVM-based Lambda functions are not the 

best performing, especially with start-up times, but I am not sure that performance is a priority for me. Perhaps 

with GraalVM is can be improved. I considered using a nodeJS/Javascript markdown-to-html Lambda function, but I am 

not a Javascript developer and have very little experience of the nodeJS ecosystem.

### Project structure

The root project will use AWS CDK to build the AWS Cloudformation templates, to set up S3 buckets, Lambda functions, 

API gateway, and so on. I have a little experience in using CDK for this.

Sub-modules in the project will provide the Lambda functions for HTML generation, templating, and other actions.

- I have also included a Web front-end in this project, but I think that is a mistake. Front-ends should be in a separate project and a separate repository. While it might be nice to share data classes between front and back ends, I could probably do that by building a separate .jar file from my `SharedModels` module.

- The long-term goal is to have Web, Android and Desktop front-ends, but I haven't decided on the approach for that. It makes sense to use _Jetpack Compose_ for the desktop and android interfaces, but I don't think that's a good fit for web. For now, I am writing a web front end using _sveltekit_. But I really dislike writing Javascript, and Typescript doesn't improve my mood either.

## Motivation

This could be considered a successor to my [bascule](https://github.com/v79/bascule-static) static site generator, a command-line driven application which 

got weighed down by poor program design and my own lack of experience. I have been keen to rebuild _bascule_ as 

web-first application for several years, frustrated by my inability to make website updates away from my PC.