@@ -9,7 +9,6 @@
-
@@ -20,7 +19,27 @@ It uses a [declarative syntax](#declarative-syntax) that allows creating and dea
The package also provides an [http.handler](#http-handler) ready to serve all the required resources to run Go-based progressive web apps.
-## Install
+## Documentation
+
+[![go-app documentation](docs/web/images/go-app.png)](https://go-app.dev)
+
+- [Getting started](https://go-app.dev/start)
+- [Architecture](https://go-app.dev/architecture)
+- [Reference](https://go-app.dev/reference) | [Go.dev](https://pkg.go.dev/github.com/maxence-charriere/go-app/v7/pkg/app)
+
+- [Components](https://go-app.dev/components)
+- [Declarative syntax](https://go-app.dev/syntax)
+- [Routing](https://go-app.dev/routing)
+- [Concurrency](https://go-app.dev/concurrency)
+- [Javascript and DOM](https://go-app.dev/js)
+- [Static resources](https://go-app.dev/static-resources)
+
+- [Built with go-app](https://go-app.dev/built-with)
+- [Intall](https://go-app.dev/install)
+
+## Sneak peek
+
+### Install
**go-app** requirements:
@@ -28,25 +47,11 @@ The package also provides an [http.handler](#http-handler) ready to serve all th
- [Go module](https://github.com/golang/go/wiki/Modules)
```sh
-# Init go module (if not initialized):
go mod init
-
-# Get package:
-go get -u -v github.com/maxence-charriere/go-app/v7
+go get -u github.com/maxence-charriere/go-app/v7/pkg/app
```
-## How it works
-
-
-
-
-
-- **Users:** The users of your app. They request pages and resources from their web browser.
-- **[app.Handler](https://pkg.go.dev/github.com/maxence-charriere/go-app/pkg/app#Handler)**: An [http.Handler](https://golang.org/pkg/net/http/#Handler) used by your server or cloud function. It serves your app, its static resources, and all the required files to make it work on user browsers.
-- **Application**: Your app built with this package. It is built as a WebAssembly (.wasm) binary and is served by the [app.Handler](https://pkg.go.dev/github.com/maxence-charriere/go-app/pkg/app#Handler).
-- **Other static resources**: Styles, images, and scripts used by your app. They are also served by the [app.Handler](https://pkg.go.dev/github.com/maxence-charriere/go-app/pkg/app#Handler).
-
-## Declarative syntax
+### Declarative syntax
**go-app** uses a declarative syntax so you can write component-based UI elements just by using the Go programming language.
@@ -101,7 +106,7 @@ GOARCH=wasm GOOS=js go build -o app.wasm
Note that the build output is named `app.wasm` because the HTTP handler expects the wasm app to be named that way in order to serve its content.
-## HTTP handler
+### HTTP handler
Once the wasm app is built, the next step is to serve it.
@@ -148,45 +153,12 @@ The directory should look like as the following:
└── app.wasm # Wasm binary
```
-## Works on mainstream browsers
-
-| | Chrome | Edge | Firefox | Opera | Safari |
-| :------ | :----: | :--: | :-----: | :---: | :----: |
-| Desktop | ✔ | ✔\* | ✔ | ✔ | ✔ |
-| Mobile | ✔ | ✔ | ✔ | ✔ | ✔ |
-
-\*_only Chromium based [Edge](https://www.microsoft.com/edge)_
-
-## Demo
-
-The hello example introduced above:
-
-| Sources | Description |
-| --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| [hello](https://github.com/maxence-charriere/go-app-demo/tree/v6/hello) | Hello app. |
-| [hello-local](https://github.com/maxence-charriere/go-app-demo/tree/v6/hello-local) | Hello app that runs on a local server. |
-| [hello-local-external-root](https://github.com/maxence-charriere/go-app-demo/tree/v6/hello-local-external-root) | Hello app that runs on a local server but with a custom root directory. |
-| [hello-docker](https://github.com/maxence-charriere/go-app-demo/tree/v6/hello-docker) | Hello app that run in a Docker container. |
-| [hello-gcloud-appengine](https://github.com/maxence-charriere/go-app-demo/tree/v6/hello-gcloud-appengine) | Hello app that run on Google Cloud App Engine. [See live](https://go-app-demo-42.appspot.com) |
-| [hello-gcloud-func](https://github.com/maxence-charriere/go-app-demo/tree/v6/hello-gcloud-func) | Hello app that run on Google a Cloud Function. [See live](https://go-app-demo-42.firebaseapp.com) |
-
-## Live apps
-
-