README
¶
Blue Jay - Blueprint
Blueprint for your next web application in Go.
Documentation available here: http://blue-jay.github.io/
Blue Jay is a web toolkit for Go. It's a collection of command-line tools and a web blueprint that allows you to easily structure your web application. There is no rigid framework to which you have to conform.
There are a few components:
-
Blueprint is a model-view-controller (MVC) style web skeleton.
-
Jay is a command-line tool with modules for find/replace, database migrations, code generation, and env.json.
Check the milestones for project status.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bootstrap handles the initialization of the web components.
|
Package bootstrap handles the initialization of the web components. |
|
Package controller loads the routes for each of the controllers.
|
Package controller loads the routes for each of the controllers. |
|
about
Package about displays the About page.
|
Package about displays the About page. |
|
debug
Package debug provides access to pprof.
|
Package debug provides access to pprof. |
|
home
Package home displays the Home page.
|
Package home displays the Home page. |
|
login
Package login handles the user login.
|
Package login handles the user login. |
|
notepad
Package notepad provides a simple CRUD application in a web page.
|
Package notepad provides a simple CRUD application in a web page. |
|
register
Package register handles the user creation.
|
Package register handles the user creation. |
|
static
Package static serves static files like CSS, JavaScript, and images.
|
Package static serves static files like CSS, JavaScript, and images. |
|
status
Package status provides all the error pages like 404, 405, 500, 501, and the page when a CSRF token is invalid.
|
Package status provides all the error pages like 404, 405, 500, 501, and the page when a CSRF token is invalid. |
|
lib
|
|
|
asset
Package asset contains FuncMap for template packages to provide asset paths with timestamps.
|
Package asset contains FuncMap for template packages to provide asset paths with timestamps. |
|
database
Package database provides a wrapper around the sqlx package.
|
Package database provides a wrapper around the sqlx package. |
|
email
Package email provides email sending via SMTP.
|
Package email provides email sending via SMTP. |
|
flash
Package flash provides one-time messages for the user.
|
Package flash provides one-time messages for the user. |
|
flight
Package flight provides an abstraction around commonly used features.
|
Package flight provides an abstraction around commonly used features. |
|
form
Package form provides form validation, repopulation for controllers and a funcmap for the html/template package.
|
Package form provides form validation, repopulation for controllers and a funcmap for the html/template package. |
|
jsonconfig
Package jsonconfig handles loading a JSON file into a struct.
|
Package jsonconfig handles loading a JSON file into a struct. |
|
passhash
Package passhash provides password hashing functionality using bcrypt.
|
Package passhash provides password hashing functionality using bcrypt. |
|
router
Package router combines routing and middleware handling in a single package.
|
Package router combines routing and middleware handling in a single package. |
|
server
Package server is a wrapper around the net/http package that starts listeners for HTTP and HTTPS.
|
Package server is a wrapper around the net/http package that starts listeners for HTTP and HTTPS. |
|
session
Package session provides a wrapper for gorilla/sessions package.
|
Package session provides a wrapper for gorilla/sessions package. |
|
uuid
Package uuid generates unique identifiers.
|
Package uuid generates unique identifiers. |
|
view
Package view provides thread-safe caching of HTML templates.
|
Package view provides thread-safe caching of HTML templates. |
|
xsrf
Package xsrf is a container for the gorilla csrf package
|
Package xsrf is a container for the gorilla csrf package |
|
middleware
|
|
|
acl
Package acl provides http.Handlers to prevent access to pages for authenticated users and for non-authenticated users.
|
Package acl provides http.Handlers to prevent access to pages for authenticated users and for non-authenticated users. |
|
logrequest
Package logrequest provides an http.Handler that logs when a request is made to the application and lists the remote address, the HTTP method, and the URL.
|
Package logrequest provides an http.Handler that logs when a request is made to the application and lists the remote address, the HTTP method, and the URL. |
|
rest
Package rest allows changing the HTTP method via a query string.
|
Package rest allows changing the HTTP method via a query string. |
|
Package model provides error standardization for the models.
|
Package model provides error standardization for the models. |
|
note
Package note provides access to the note table in the MySQL database.
|
Package note provides access to the note table in the MySQL database. |
|
user
Package user provides access to the user table in the MySQL database.
|
Package user provides access to the user table in the MySQL database. |
|
userstatus
Package userstatus provides access to the user_status table in the MySQL database.
|
Package userstatus provides access to the user_status table in the MySQL database. |
|
viewfunc
|
|
|
link
Package link provides a funcmap for html/template to generate a hyperlink.
|
Package link provides a funcmap for html/template to generate a hyperlink. |
|
noescape
Package noescape provides a funcmap for html/template to prevent escaping a string.
|
Package noescape provides a funcmap for html/template to prevent escaping a string. |
|
prettytime
Package prettytime provides a funcmap for html/template to that displays time using an easy to read format.
|
Package prettytime provides a funcmap for html/template to that displays time using an easy to read format. |
|
viewmodify
|
|
|
authlevel
Package authlevel adds an AuthLevel variable to the view template.
|
Package authlevel adds an AuthLevel variable to the view template. |
|
uri
Package uri adds URI shortcuts to the view template.
|
Package uri adds URI shortcuts to the view template. |
Click to show internal directories.
Click to hide internal directories.