https://github.com/junland/sled

A simple boiler-plate for web apps.
https://github.com/junland/sled

12-factor boilerplate golang golang-application microservice webapp

Last synced: 3 months ago
JSON representation

A simple boiler-plate for web apps.

• Host: GitHub
• URL: https://github.com/junland/sled
• Owner: junland
• License: mit
• Created: 2018-01-26T03:10:58.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-09-15T13:39:48.000Z (over 5 years ago)
• Last Synced: 2023-03-04T16:09:45.572Z (about 3 years ago)
• Topics: 12-factor, boilerplate, golang, golang-application, microservice, webapp
• Language: Go
• Homepage:
• Size: 6.51 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Sled [![Build Status](https://travis-ci.org/junland/sled.svg?branch=master)](https://travis-ci.org/junland/sled) [![GoDoc](https://godoc.org/github.com/junland/sled?status.svg)](http://godoc.org/github.com/junland/sled)

A simple boiler-plate for web apps.

## 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](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/junland/pak-mule/tags).

## Authors

* **John Unland** - *Initial work* - [junland](https://github.com/junland)

See also the list of [contributors](https://github.com/your/project/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.