https://github.com/wolfeidau/echo-spa-middleware

This echo middleware for use with single page applications (SPA).
https://github.com/wolfeidau/echo-spa-middleware

echo golang middleware spa

Last synced: 27 days ago
JSON representation

This echo middleware for use with single page applications (SPA).

• Host: GitHub
• URL: https://github.com/wolfeidau/echo-spa-middleware
• Owner: wolfeidau
• License: apache-2.0
• Created: 2020-04-10T08:51:42.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-24T01:36:19.000Z (almost 5 years ago)
• Last Synced: 2024-11-18T03:28:40.209Z (3 months ago)
• Topics: echo, golang, middleware, spa
• Language: Go
• Homepage: https://github.com/wolfeidau/echo-spa-middleware
• Size: 46.9 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# echo-spa-middleware

This [echo](https://echo.labstack.com/) middleware for use with single page applications (SPA). It resolves the `index.html` in a static file store with logic to support client side routing and optional sub domain path prefixing for branch builds.

# Configuration

This echo middleware has a couple of key configuration options.

* **DomainName** - This option enabled the middleware to recognise sub domain request and is used to support branch builds.

* **SubDomainMode** - This can be enabled to support rewriting of sub domain to path prefix.

# Sub Domains

This middleware supports using the sub domain which prefixes `domainName` and use it to form a part of the logic to locate the `indexFile` to be served.

So with a configuration of the following:

```go

e := echo.New()

e.Pre(echomiddleware.AddTrailingSlash()) // required to ensure trailing slash is appended

e.Use(spa.IndexWithConfig(spa.RedirectConfig{

  DomainName: "www.example.com",

  SubDomainMode: true,

}))

```

## branch mode

This middleware supports enabling a branch mode, to support branch builds of an SPA.

At least two DNS records pointing at this service being:

* `www.example.com`

* `*.www.example.com`

Request URI | path served

--- | ---

http://example.com | /index.html

http://mybranch_build.example.com | /mybranch_build/index.html

http://example.com/someroute  | /index.html

http://mybranch_build.example.com/someroute | /mybranch_build/index.html

http://mybranch_build.example.com/img/logo.png | /mybranch_build/img/logo.png

# License

This library is released under Apache 2.0 license and is copyright [Mark Wolfe](https://www.wolfe.id.au).