From: early Date: Tue, 13 Aug 2024 00:09:02 +0000 (-0600) Subject: Remove examples, add README, update go X-Git-Url: https://git.earlybird.gay/?a=commitdiff_plain;h=5cbaba11d8800eaddac8cd94b7df0c66ac1b942a;p=today Remove examples, add README, update go --- diff --git a/README.md b/README.md deleted file mode 100644 index 98c82e2..0000000 --- a/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# Today Web Engine - -The Today engine builds on Go's templating with reusable parts in the style of -the Web Components standard. It aims to be usable for anything from static HTML -websites to complex applications with a mix of server and client-side behavior. - -## Install - -```sh -go get git.earlybird.gay/today-engine@latest -``` - -## Usage - -Currently, the `examples` folder contains a site going through concepts by -example. You can walk through these examples yourself by installing them as -an executable: - -```sh -go install git.earlybird.gay/today-engine/cmd/run-today-examples@latest -run-today-examples -``` - -## License - -> This section is not legally binding, please read the license text for -> specifics! - -The Today Web Engine is licensed under the LGPL (GNU Lesser General Public -License). This license affects how you can run, modify, and distribute -today-engine. In short: - -- If you modify today-engine, you have to publish your modifications under the - GPL or LGPL. -- If you use today-engine without modifying it, you're in the clear. -- Building a website using today-engine does not count as modifying today-engine. diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..ec52e38 --- /dev/null +++ b/README.txt @@ -0,0 +1,27 @@ +===== Today Engine ============================================================= + +The Today engine builds on Go's templating with reusable parts in the style of +the Web Components standard. It aims to be usable for anything from static HTML +websites to complex applications with a mix of server and client-side behavior. + +===== Install ================================================================== + +go get git.earlybird.gay/today-engine@latest + +===== Usage ==================================================================== + +I'm working on a by-example application to help with this. + +===== License ================================================================== + +> This section is not legally binding, please read the license text for +> specifics! + +The Today Web Engine is licensed under the LGPL (GNU Lesser General Public +License). This license affects how you can run, modify, and distribute +today-engine. In short: + +- If you modify today-engine, you have to publish your modifications under the + GPL or LGPL. +- If you use today-engine without modifying it, you're in the clear. +- Building a website using today-engine does not count as modifying today-engine. diff --git a/app.go b/app.go deleted file mode 100644 index f16ebc9..0000000 --- a/app.go +++ /dev/null @@ -1,10 +0,0 @@ -// Copyright (C) 2024 early (LGPL) -package engine - -import ( - "net/http" -) - -type App struct { - http.ServeMux -} diff --git a/cmd/run-today-examples/ex01-pages/example.go b/cmd/run-today-examples/ex01-pages/example.go deleted file mode 100644 index ee1056f..0000000 --- a/cmd/run-today-examples/ex01-pages/example.go +++ /dev/null @@ -1,12 +0,0 @@ -// Copyright (C) 2024 early (LGPL) -package ex01 - -import ( - "git.earlybird.gay/today-engine/page" -) - -// Make a page like this, with page.New(name, file). Name doesn't matter much -// for pages. File is a path to a file relative to *this Go file*, NOT the -// working directory. -// A Page is an http.Handler! -var Page = page.New("ex01", "page.html") diff --git a/cmd/run-today-examples/ex01-pages/page.html b/cmd/run-today-examples/ex01-pages/page.html deleted file mode 100644 index b5ba9b6..0000000 --- a/cmd/run-today-examples/ex01-pages/page.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - Example 1 - - - - -
-

Static HTML

-

Today supports regular HTML, without any modification. All of the - features you'll see in these examples add on to the "normal experience". - For each example, you'll see the rendered result in the browser, plus - source files to show how that example is constructed. -

- - - -

Sources for this example

- - -

page.html

- 
ᐸ!DOCTYPE htmlᐳ
-ᐸhtmlᐳ
-ᐸheadᐳ
-  ᐸtitleᐳExample 1ᐸ/titleᐳ
-  ᐸlink rel="stylesheet" href="/style.css"ᐳ
-ᐸ/headᐳ
-
-ᐸbodyᐳ
-  ᐸmainᐳ
-    ᐸh1ᐳStatic HTMLᐸ/h1ᐳ
-    ᐸpᐳToday supports regular HTML, without any modification. All of the
-      features you'll see in these examples add on to the "normal experience".
-      For each example, you'll see the rendered result in the browser, plus
-      source files to show how that example is constructed.
-    ᐸ/pᐳ
-
-    ᐸh2ᐳSources for this exampleᐸ/h2ᐳ
-    ᐸ!-- source-preview does not belong to the HTML specification, but elements
-      with - in the name are allowed! We're going to do something with this in
-      a second. --ᐳ
-    ᐸsource-previewᐳ
-      ᐸh3ᐳpage.htmlᐸ/h3ᐳ
-      ᐸpreᐳᐸcodeᐳ...ᐸ/codeᐳᐸ/preᐳ
-    ᐸ/source-previewᐳ
-    ᐸsource-previewᐳ
-      ᐸh3ᐳexample.goᐸ/h3ᐳ
-      ᐸpreᐳᐸcodeᐳ...ᐸ/codeᐳᐸ/preᐳ
-    ᐸ/source-previewᐳ
-    ᐸnavᐳ
-      ᐸa href="/ex02"ᐳPartsᐸ/aᐳ
-      ᐸa href="/"ᐳBack to Overviewᐸ/aᐳ
-    ᐸ/navᐳ
-  ᐸ/mainᐳ
-ᐸ/bodyᐳ
-
-ᐸ/htmlᐳ
- - -

example.go

- 
// Copyright (C) 2024 early (LGPL)
-package ex01
-
-import (
-  "git.earlybird.gay/today-engine/page"
-)
-
-// Make a page like this, with page.New(name, file). Name doesn't matter much
-// for pages. File is a path to a file relative to *this Go file*, NOT the
-// working directory.
-// A Page is an http.Handler!
-var Page = page.New("ex01", "page.html")
-
- -
- - - \ No newline at end of file diff --git a/cmd/run-today-examples/ex02-parts/example.go b/cmd/run-today-examples/ex02-parts/example.go deleted file mode 100644 index cfb3fea..0000000 --- a/cmd/run-today-examples/ex02-parts/example.go +++ /dev/null @@ -1,35 +0,0 @@ -// Copyright (C) 2024 early (LGPL) -package ex02 - -import ( - "math/rand/v2" - - "git.earlybird.gay/today-engine/cmd/run-today-examples/parts" - "git.earlybird.gay/today-engine/include" - "git.earlybird.gay/today-engine/page" - "git.earlybird.gay/today-engine/part" - "git.earlybird.gay/today-engine/render" -) - -// Like pages, you make parts with part.New. The name is more important for -// parts, since the name is the name of the element in HTML. -var RandomGenerator = part.New("random-generator", "random-generator.html", - part.OnLoad(func(data render.Data) error { - // Generate a random number on load. - data.Set("number", rand.Int()%100) - return nil - }), -) - -var Page = page.New("ex01", "page.html", - // When you want to use a part, you need to say so in page.Includes. - page.Includes(RandomGenerator, parts.SourcePreview), - page.OnLoad(func(data render.Data) error { - // This is all for SourcePreview, don't worry about it just yet. - sources := make(render.Data) - sources.Set("page", include.File("page.html")) - sources.Set("go", include.File("example.go")) - data.Set("sources", sources) - return nil - }), -) diff --git a/cmd/run-today-examples/ex02-parts/page.html b/cmd/run-today-examples/ex02-parts/page.html deleted file mode 100644 index 8b6dd31..0000000 --- a/cmd/run-today-examples/ex02-parts/page.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Example 1 - - - - -
-

Parts

-

- In the previous example, you saw a source-preview element, - which is not part of the HTML specification. However, custom elements with - a - in the name are allowed by the specification, because they are used - for the Web Components feature of the web platform. Today Engine borrows - this for use with server-side "parts". Examples will focus on these for - now, but we'll get into Web Components and how they're different later. -

-

- Parts allow you to define custom elements that are rendered server-side, - before any content is sent to the user agent. Each part can execute some - behavior in Go, and decide how it is rendered based on the result. Here - is a part that generates a random number every time the page is reloaded. -

- - - -

This isn't super useful.

- -

- Fortunately, these are solvable problems. In the next few examples, we'll - evaluate how to make replacable markup in parts using slots and pass data - using attributes. -

- - - - -

Sources for this example

- -

page.html

- - -

example.go

- -
- - - \ No newline at end of file diff --git a/cmd/run-today-examples/ex02-parts/random-generator.html b/cmd/run-today-examples/ex02-parts/random-generator.html deleted file mode 100644 index 6bff857..0000000 --- a/cmd/run-today-examples/ex02-parts/random-generator.html +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/cmd/run-today-examples/index.html b/cmd/run-today-examples/index.html deleted file mode 100644 index ab51f28..0000000 --- a/cmd/run-today-examples/index.html +++ /dev/null @@ -1,20 +0,0 @@ - - -
- Today Engine Examples -
- -

Today Engine Examples

-

This is a set of examples for usage of the Today Web Engine!

-

Links

-
    -
  1. Pages
    2. -
  2. Parts
    3. -
  3. Slots
    4. -
  4. Go Templates
    5. -
  5. N/A
    6. -
  6. Passing Data to Parts
    7. -
  7. Web Components
    8. -
- - \ No newline at end of file diff --git a/cmd/run-today-examples/main.go b/cmd/run-today-examples/main.go deleted file mode 100644 index 70d78b0..0000000 --- a/cmd/run-today-examples/main.go +++ /dev/null @@ -1,22 +0,0 @@ -// Copyright (C) 2024 early (LGPL) -package main - -import ( - "net/http" - - "git.earlybird.gay/today-engine/cmd/run-today-examples/ex01-pages" - "git.earlybird.gay/today-engine/cmd/run-today-examples/ex02-parts" - "git.earlybird.gay/today-engine/page" -) - -var index = page.New("index", "index.html") - -func main() { - mux := new(http.ServeMux) - mux.Handle("GET /{$}", index) - mux.Handle("GET /ex01", ex01.Page) - mux.Handle("GET /ex02", ex02.Page) - mux.Handle("GET /", http.FileServer(http.Dir("cmd/run-today-examples/public"))) - - http.ListenAndServe("0.0.0.0:3000", mux) -} diff --git a/cmd/run-today-examples/parts/parts.go b/cmd/run-today-examples/parts/parts.go deleted file mode 100644 index 8ec00d7..0000000 --- a/cmd/run-today-examples/parts/parts.go +++ /dev/null @@ -1,29 +0,0 @@ -// Copyright (C) 2024 early (LGPL) -package parts - -import ( - "errors" - "io" - "strings" - - "git.earlybird.gay/today-engine/include" - "git.earlybird.gay/today-engine/part" - "git.earlybird.gay/today-engine/render" -) - -var SourcePreview = part.New("source-preview", "source-preview.html", - part.OnLoad(func(data render.Data) error { - opener, ok := data.Get("source").(include.Opener) - if !ok || opener == nil { - return errors.New("source-preview requires include.Opener source") - } - file, err := opener.Open() - if err != nil { - return err - } - buf := new(strings.Builder) - io.Copy(buf, file) - data.Set("source_raw", buf.String()) - return nil - }), -) diff --git a/cmd/run-today-examples/parts/source-preview.html b/cmd/run-today-examples/parts/source-preview.html deleted file mode 100644 index ec9c1b0..0000000 --- a/cmd/run-today-examples/parts/source-preview.html +++ /dev/null @@ -1,4 +0,0 @@ - \ No newline at end of file diff --git a/cmd/run-today-examples/public/style.css b/cmd/run-today-examples/public/style.css deleted file mode 100644 index 557cbab..0000000 --- a/cmd/run-today-examples/public/style.css +++ /dev/null @@ -1,36 +0,0 @@ -/* The Great Reset */ -* { - padding: 0; - margin: 0; -} - -/* Containers */ - -main, section, nav { - display: flex; - flex-direction: column; - gap: .5rem; -} - -main { - margin: 2rem 20%; -} - -/* Typography */ - -/* Styling for parts and app-specific stuff */ - -source-preview { - width: fit-content; - border: 1px solid black; - border-radius: 5px; - overflow: hidden; -} - -source-preview > * { - padding: 1rem; -} - -source-preview pre { - background-color: lightgray; -} diff --git a/go.mod b/go.mod index 94e6cec..27bc819 100644 --- a/go.mod +++ b/go.mod @@ -1,5 +1,5 @@ module git.earlybird.gay/today-engine -go 1.22.0 +go 1.22.4 require golang.org/x/net v0.27.0