sled

command module
Version: v0.0.0-...-d9a1202 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2019 License: MIT Imports: 1 Imported by: 0

README

Sled Build Status GoDoc

A simple boiler-plate for web apps.

Notice: If your viewing this repo from the Github mirror, you can still contribute to this project. Please feel free to submit issues or pull requests.

Features

  • Simple layout. No frameworks. Little abstraction.

  • Modular (Easy to swap out logger, router, and middleware.)

  • Tries to adhere to the 12 factor application paradigm.

  • TLS Enabled. (Make sure to generate your key and cert.)

Getting started

Binary only builds on non-Windows systems, it's best if you use MacOS or Linux for development.

  1. Pull down the boiler plate repo. (With your Go environment already configured.)

    go get gitlab.com/junland/sled

  2. Build it!

    go build

  3. Run it!

    sudo ./sled

  4. Test it!

    http://localhost:8080/

    http://localhost:8080/hello

    http://localhost:8080/hello/Bob

  5. Hack it! Use it! Profit!

Built With

github.com/justinas/alice - Simple middleware chaining library.

github.com/sirupsen/logrus - Structured, pluggable logging for Go.

github.com/spf13/pflag - Drop in replacement for the flag package.

github.com/julienschmidt/httprouter - A high performance HTTP request router that scales well.

Versioning

I use SemVer 2.0.0 for versioning. For the versions available, see the tags on this repository.

Authors

  • John Unland - Initial work - junland

See also the list of contributors who participated in this project

License

Code is licensed under MIT which can be viewed in the LICENSE file.

Please let me know through the issues tracker if you have any questions.

TODO / Notes

  • Check issues list for more information.

Documentation

Overview

Package main is a simple wrapper of the real sled entrypoint package.

This package should NOT be extended or modified in any way; to modify the sled binary, work in the `gitlab.com/<USER>/sled/cmd` package.

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL