mu_app

README

mu-app

This is a complete sample of all Mu functionality. It is a good starting point for a new project based on Mu.

Creating a new app

To create a new app based on mu-app, you can use the following command:

go run github.com/neuralnorthwest/mu-app/cmd/new@latest my-app

This takes care of cloning the mu-app repository, removing the .git folder, and renaming all references to mu-app to my-app.

Enabling badges

By default, the badges at the top of this README.md will be removed. To keep them, you need to specify the GitHub owner and repository name that you will be pushing to. Do with with the --target flag:

go run github.com/neuralnorthwest/mu-app/cmd/new@latest my-app --target my-name/my-app

Developer quick start

If you want work on mu-app, you can use the following commands to get started:

git clone https://github.com/neuralnorthwest/mu-app.git
cd mu-app
make setup-dev

Contributing

See CONTRIBUTING.md for more information.

Code of Conduct

See CODE_OF_CONDUCT.md for more information.

Documentation

Index

• Constants
• func New(name string) (*muApp, error)
• func Version() string
• type Config
  • func (c *Config) DevMode() bool
  • func (c *Config) Message() string

Constants

const DevModeConfigVar = "DEV_MODE"

const (
	HelloPath = "/hello"
)

const MessageConfigVar = "MESSAGE"

Functions

func New

func New(name string) (*muApp, error)

New creates a new mu-app service.

func Version

func Version() string

Version returns the version of mu.

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config is a convenience wrapper around the service configuration.

func (*Config) DevMode

func (c *Config) DevMode() bool

DevMode returns true if development mode is enabled.

func (*Config) Message

func (c *Config) Message() string

Message returns the message to display.