README
¶
arikawa-boilerplate
A boilerplate for arikawa-powered Discord bots
Table of Contents
About the Project
This is a template project which is aimed to help others with setting up new projects and GitHub repositories for them.
Getting Started
Prerequisites
- A GitHub account
- A will to use this template
Setting It Up
Simply click the Use this template green button at the very top of this page to get started.
Don't forget to check the Include all branches box when creating your repository—it is not required, but recommended
as it will bring some extra necessary branches, e.g. repo-assets/* branches.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create, so any contributions you make are greatly appreciated.
If you would like to contribute, please make sure to take a look at this guideline beforehand.
Please see our security policy to report any possible vulnerabilities or serious issues.
License
Distributed under the MIT License. See
LICENSE.md for more information.
N.B. This project explicitly does not requires its contributors to sign a Contributor License Agreement nor does it posses one.
Documentation
¶
Overview ¶
Package main is the package that contains the entry point for the application.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd is the package that contains all of the commands for the application.
|
Package cmd is the package that contains all of the commands for the application. |
|
internal
|
|
|
pkg/asset
Package asset is the package that contains all of the assets for the application.
|
Package asset is the package that contains all of the assets for the application. |
|
pkg/builder
Package builder is the package that contains all of the builder functions and types.
|
Package builder is the package that contains all of the builder functions and types. |
|
pkg/cachecontainer
Package cachecontainer is the package that contains the cache container.
|
Package cachecontainer is the package that contains the cache container. |
|
pkg/cmd
Package cmd is the package that contains all of the command handling logic.
|
Package cmd is the package that contains all of the command handling logic. |
|
pkg/middleware
Package middleware provides a set of middleware for the router.
|
Package middleware provides a set of middleware for the router. |
|
pkg/presence
Package presence is the package that contains all of the presence related functions and types.
|
Package presence is the package that contains all of the presence related functions and types. |
|
pkg/provide
Package provide is the package that contains all of the providers for the dependency injection container.
|
Package provide is the package that contains all of the providers for the dependency injection container. |
|
pkg/router
Package router is the package that provides the command router.
|
Package router is the package that provides the command router. |
|
pkg/util
Package util is the package that contains all of the utility functions and types.
|
Package util is the package that contains all of the utility functions and types. |
|
pkg
|
|
|
logger
Package logger is the package that provides logging functionality.
|
Package logger is the package that provides logging functionality. |
|
logger/asynczap
Package asynczap is the package that provides the AsyncZap logger.
|
Package asynczap is the package that provides the AsyncZap logger. |
|
logger/zap
Package zap is the package that provides the Zap logger.
|
Package zap is the package that provides the Zap logger. |