web

README

web

This project uses React built with Vite.

Available Scripts

In the project directory, you can run:

pnpm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

pnpm run build

Builds the app for production to the dist folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Learn More

To learn React, check out the React documentation.

Documentation

Overview

Package web web/build.go

Index

• Variables
• func FileFS(r *chi.Mux, path, file string, filesystem fs.FS)
• func Index(w io.Writer, p IndexParams) error
• func Manifest(w io.Writer, p IndexParams) error
• func MustSubFS(currentFs fs.FS, fsRoot string) fs.FS
• func RegisterHandler(c *chi.Mux, version, baseUrl string)
• func StaticFS(r *chi.Mux, pathPrefix string, filesystem fs.FS)
• func StaticFileHandler(file string, filesystem fs.FS) http.HandlerFunc
• type IndexParams

Variables

var (
	//go:embed all:dist
	Dist embed.FS

	DistDirFS = MustSubFS(Dist, "dist")
)

Functions

func FileFS

func FileFS(r *chi.Mux, path, file string, filesystem fs.FS)

FileFS registers a new route with path to serve a file from the provided file system.

func Index

func Index(w io.Writer, p IndexParams) error

func Manifest

func Manifest(w io.Writer, p IndexParams) error

func MustSubFS

func MustSubFS(currentFs fs.FS, fsRoot string) fs.FS

MustSubFS creates sub FS from current filesystem or panic on failure. Panic happens when `fsRoot` contains invalid path according to `fs.ValidPath` rules.

MustSubFS is helpful when dealing with `embed.FS` because for example `//go:embed assets/images` embeds files with paths including `assets/images` as their prefix. In that case use `fs := MustSubFS(fs, "rootDirectory") to create sub fs which uses necessary prefix for directory path.

func RegisterHandler

func RegisterHandler(c *chi.Mux, version, baseUrl string)

RegisterHandler register web routes and file serving

func StaticFS

func StaticFS(r *chi.Mux, pathPrefix string, filesystem fs.FS)

StaticFS registers a new route with path prefix to serve static files from the provided file system.

func StaticFileHandler

func StaticFileHandler(file string, filesystem fs.FS) http.HandlerFunc

StaticFileHandler creates a handler function to serve a file from the provided file system.

Types

type IndexParams

type IndexParams struct {
	Title   string
	Version string
	BaseUrl string
}