all repos — quartzgun @ main

lightweight web framework in go

31f42d90
IndentalUserDB: use RWMutex; update test file; gofmt
Iris Lightshard nilix@nilfm.cc
d4568922
indentalUserDB: add mutex for writes and initialize map on UserAdd
Iris Lightshard nilix@nilfm.cc
8f0c5206
update package URL; v0.3.0
Iris Lightshard nilix@nilfm.cc

quartzgun

A lightweight web framework for Go

Quartz Gun effect from Eureka Seven AO, showing a tree of light spanning down to the earth with its root in low orbit

philosophy/design

quartzgun is designed to enable speedy development of efficient web sites and APIs in Go. There are no dependencies outside of the standard library except for bcrypt, and the library is modular – you can use any part of it independently. The router uses the func(http.Handler) http.Handler middleware pattern so that you can plug and play existing middleware.

There are pre-made renderers which are designed as plug and play endpoints in your middleware chains. They are used for providing the basic functionality of the route, rendering an HTML template in the case of a normal page, or JSON or XML for API endpoints.

The auth system is designed from scratch to provide a modular system where new authentication/authorization backends can be added easily by satisfying the auth.UserStore interface.

about the name

Thinking about URL routes reminded me of the tree of light the fictional Quartz Gun emits when fired, so I named the library quartzgun.

usage

A more complete usage guide will be forthcoming, but for now you can check out the quartzgun_test.go file for an overview of how to use it.

roadmap/features

Features may be added here at any time as things are in early stages right now:

core functionality

auth

etc

license

quartzgun is licensed under the MIT license – see the LICENSE file for details but the long and short of it is you can use/modify it for any reason, but give me (and other authors where applicable) credit for writing it.

contributing

Send patches to nilix@nilfm.cc using git format-patch -s HEAD~<however many commits>. The -s flag ensures that your name makes it into the commit log.

clone
git clone https://hacklab.nilfm.cc/quartzgun