Documentation
¶
Overview ¶
Package praelatus is a place holder package to make the godoc better formatted
Praelatus is an Open Source bug tracking and ticketing system. The backend API is written in Go and the frontend is written in Vue.js. You are viewing the Godoc for the Backend if you would like information about how to use the API as a client or how to start working on the backend visit http://docs.praelatus.io
Copyright (C) 2017 Mathew Robinson <chasinglogic@gmail.com>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api has our router and HTTP handlers for all of the available api routes
|
Package api has our router and HTTP handlers for all of the available api routes |
|
middleware
Package middleware contains the HTTP middleware used in the api as well as utility functions for interacting with them
|
Package middleware contains the HTTP middleware used in the api as well as utility functions for interacting with them |
|
utils
Package utils contains utility functions used throughout the api package
|
Package utils contains utility functions used throughout the api package |
|
v1
Package v1 contains all of the routes and handlers for v1 of the API
|
Package v1 contains all of the routes and handlers for v1 of the API |
|
cmd
|
|
|
Package commands holds all the logic for the CLI of Praelatus
|
Package commands holds all the logic for the CLI of Praelatus |
|
Package config defines the config struct and provides utility methods for querying it.
|
Package config defines the config struct and provides utility methods for querying it. |
|
Package events handles sending notifications to users and websockets when system events happen.
|
Package events handles sending notifications to users and websockets when system events happen. |
|
Package files provides definitions for abstracting away filesystem interaction in Praelatus
|
Package files provides definitions for abstracting away filesystem interaction in Praelatus |
|
Package models contains all of our models and utility functions for creating and modifying them
|
Package models contains all of our models and utility functions for creating and modifying them |
|
permission
Package permission is used to store the various permission in praelatus, it acts as a pseudo-enumeration
|
Package permission is used to store the various permission in praelatus, it acts as a pseudo-enumeration |
|
Package ql contains the lexer and parser for PQL ticket searching language
|
Package ql contains the lexer and parser for PQL ticket searching language |
|
ast
Package ast describes an abstract syntax tree for PQL
|
Package ast describes an abstract syntax tree for PQL |
|
lexer
Package lexer contains the lexer for PQL
|
Package lexer contains the lexer for PQL |
|
parser
Package parser contains the parser / validator for PQL
|
Package parser contains the parser / validator for PQL |
|
token
Package token contains the tokens for PQL
|
Package token contains the tokens for PQL |
|
Package repo provides definitions for abstracting away database interaction in Praelatus
|
Package repo provides definitions for abstracting away database interaction in Praelatus |
|
mongo
Package mongo implements repo.Repo for a mongodb database.
|
Package mongo implements repo.Repo for a mongodb database. |