README
Documentation
¶
Overview ¶
This is the entry point for mouthful, the self hosted commenting engine.
Upon providing a config, the main program will parse it and start an API.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
model
Package model contains the model definitions for mouthful API response and request types.
|
Package model contains the model definitions for mouthful API response and request types. |
|
Package config deals with parsing and manipulation of the config files.
|
Package config deals with parsing and manipulation of the config files. |
|
model
Package model deals with the model definitions of the configuration file.
|
Package model deals with the model definitions of the configuration file. |
|
Package db is responsible for database access.
|
Package db is responsible for database access. |
|
abstraction
Package abstraction defines all the required interfaces to make the database layer pluggable.
|
Package abstraction defines all the required interfaces to make the database layer pluggable. |
|
dynamodb
Package dynamodb is responsible for connections and data manipulation on dynamodb
|
Package dynamodb is responsible for connections and data manipulation on dynamodb |
|
dynamodb/model
Package model deals with specific models for dynamodb(they might be a bit different to db/model).
|
Package model deals with specific models for dynamodb(they might be a bit different to db/model). |
|
model
Package model contains the models consumed by the databases.
|
Package model contains the models consumed by the databases. |
|
sqlxDriver
Package sqlxDriver allows for data manipulation through the github.com/jmoiron/sqlx package.
|
Package sqlxDriver allows for data manipulation through the github.com/jmoiron/sqlx package. |
|
sqlxDriver/mysql
Package mysql is responsible for mysql database connections and initialization.
|
Package mysql is responsible for mysql database connections and initialization. |
|
sqlxDriver/postgres
Package postgres is responsible for postgres database connections and initialization.
|
Package postgres is responsible for postgres database connections and initialization. |
|
sqlxDriver/sqlite
Package sqlite is responsible for sqlite database connections and initialization.
|
Package sqlite is responsible for sqlite database connections and initialization. |
|
tool
Package tool contains various utilities used with the mouthful database
|
Package tool contains various utilities used with the mouthful database |
|
Package global provides constants, defaults and helper methods to mouthful.
|
Package global provides constants, defaults and helper methods to mouthful. |
Click to show internal directories.
Click to hide internal directories.