README
¶
Blue Jay - Core
Core packages available to Blueprint and Jay as well as other applications.
Documentation available here: https://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.
-
Core is a collection of packages available to Blueprint and Jay as well as other applications.
Check the milestones for project status.
Code Coverage
asset 96%
email 100%
env 91%
file 100%
find 89%
flash 100%
form 73%
generate 88%
jsonconfig 100%
passhash 75%
replace --
router 100%
server 16%
session 100%
storage --
uuid 80%
view 94%
xsrf 100%
Directories
¶
| Path | Synopsis |
|---|---|
|
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. |
|
Package email provides email sending via SMTP.
|
Package email provides email sending via SMTP. |
|
Package env creates and updates the env.json file.
|
Package env creates and updates the env.json file. |
|
Package file provides helpful filesystem functions.
|
Package file provides helpful filesystem functions. |
|
Package find will search for matched case-sensitive strings in files.
|
Package find will search for matched case-sensitive strings in files. |
|
Package flash provides one-time messages for the user.
|
Package flash provides one-time messages for the user. |
|
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. |
|
Package generate will parse and create files from template pairs.
|
Package generate will parse and create files from template pairs. |
|
Package jsonconfig handles loading a JSON file into a struct.
|
Package jsonconfig handles loading a JSON file into a struct. |
|
Package pagination assists with navigating between pages of results.
|
Package pagination assists with navigating between pages of results. |
|
Package passhash provides password hashing functionality using bcrypt.
|
Package passhash provides password hashing functionality using bcrypt. |
|
Package replace will search for matched case-sensitive strings in files and then replace them with a different string.
|
Package replace will search for matched case-sensitive strings in files and then replace them with a different string. |
|
Package router combines routing and middleware handling in a single package.
|
Package router combines routing and middleware handling in a single package. |
|
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. |
|
Package session provides a wrapper for gorilla/sessions package.
|
Package session provides a wrapper for gorilla/sessions package. |
|
Package storage loads the configuration file with only storage information.
|
Package storage loads the configuration file with only storage information. |
|
driver/mysql
Package mysql provides a wrapper around the sqlx package.
|
Package mysql provides a wrapper around the sqlx package. |
|
driver/postgresql
Package postgresql provides a wrapper around the pq package.
|
Package postgresql provides a wrapper around the pq package. |
|
migration
Package migration provides an interface for migrating a database backwards and forwards.
|
Package migration provides an interface for migrating a database backwards and forwards. |
|
migration/mysql
Package mysql implements MySQL migrations.
|
Package mysql implements MySQL migrations. |
|
Package uuid generates unique identifiers.
|
Package uuid generates unique identifiers. |
|
Package view provides thread-safe caching of HTML templates.
|
Package view provides thread-safe caching of HTML templates. |
|
Package xsrf is a container for the gorilla csrf package
|
Package xsrf is a container for the gorilla csrf package |
Click to show internal directories.
Click to hide internal directories.