wiki

package module

v0.0.0-...-a333e2e Latest Latest Go to latest Published: Dec 6, 2017 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/suzuken/wiki

Links

Open Source Insights

README ¶

wiki

Example implementation of wiki.

How to run

go get github.com/suzuken/wiki/cmd/wiki
wiki

or

make run

Requirements

Go 1.7 or later
MySQL 5.6

Tips

Generate Scans

Using scaneo. Simply,

# edit models, and
make gen

DB

Use docker container. For database migration, sql-migrate

# Docker's MySQL build
make docker/build
make docker/start

# run migrate/up after adding ddl in migrations dir.
make migrate/up

Originally from gin-boilerplate

Author

Kenta SUZUKI a.k.a. suzuken

LICENSE

MIT

Documentation ¶

Overview ¶

Use of this source code is governed by a BSD-style license that can be found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.

This handler implementation is based on gddo. https://github.com/golang/gddo/tree/master/gddo-server

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Auth ¶

func Auth(h handler) handler

Auth verify if session user is logged in.

func GET ¶

func GET(h handler) handler

func POST ¶

func POST(h handler) handler

Types ¶

type Server ¶

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

Server is whole server implementation for this wiki app. This holds database connection and router settings.

func New ¶

func New() *Server

New returns server object.

func (*Server) Close ¶

func (s *Server) Close() error

Close makes the database connection to close.

func (*Server) Init ¶

func (s *Server) Init(dbconf, env string, debug bool)

Init initialize server state. Connecting to database, compiling templates, and settings router.

func (*Server) Route ¶

func (s *Server) Route()

Route setting router for this wiki.

func (*Server) Run ¶

func (s *Server) Run(addr string)

Run starts running http server.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
wiki
controller
db
httputil originally from github.com/golang/gddo/httputil.(ResponseBuffer)	originally from github.com/golang/gddo/httputil.(ResponseBuffer)
model
sessions
view

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