mirror of
https://github.com/Sheldan/abstracto.git
synced 2026-01-06 09:20:17 +00:00
9374dfb912
fixed some table names to be singular migrated templates to separate repository added seed data to initial version in liquibase migrations instead of property files (post targets, emotes etc) and created some default tables containing those default values added separate artifacts to be used containing only the liquibase config added shell script as a wrapper for ansible deployment, to handle an environment variable defining whether or not the deployment should be executed added logback scan period added licenses for ansible, liquibase, docker and docker-compose
36 lines
2.9 KiB
Markdown
36 lines
2.9 KiB
Markdown
# Abstracto
|
|
|
|
|
|
[](https://sonarcloud.io/dashboard?id=abstracto-abstracto)
|
|
[](https://sonarcloud.io/dashboard?id=abstracto-abstracto)
|
|
[](https://github.com/Sheldan/abstracto/blob/master/LICENSE)
|
|
|
|
|
|
Abstracto represents a framework to be used as a basis for a Discord bot. It uses [JDA](https://github.com/DV8FromTheWorld/JDA/) as an API wrapper underneath
|
|
and provides an extensive tool set to create new commands and a wide range of commands out of the box.
|
|
|
|
This repository does not provide the full functionality in order to start a discord bot, because it requires a Main class.
|
|
An example implementation of this bot can be seen [here](https://github.com/Sheldan/Crimson). This repository contains the required configuration in order to run a bot and example customizations.
|
|
|
|
|
|
## Technologies
|
|
* [JDA](https://github.com/DV8FromTheWorld/JDA/) The Discord API Wrapper in the version 4.1.1_167
|
|
* [Spring boot](https://github.com/spring-projects/spring-boot) is used as a framework to create standalone application in Java with Java EE methods. (including Dependency injection and more)
|
|
* [Hibernate](https://github.com/hibernate/hibernate-orm) is used as a reference implementation of JPA.
|
|
* [Freemarker](https://github.com/apache/freemarker) is used as a templating engine. This is used to provide internationalization for user facing text and enable dynamic embed configuration.
|
|
* [Ehcache](https://github.com/ehcache/ehcache3) is used as a caching implementation for the database and other caches.
|
|
* [Lombok](https://github.com/rzwitserloot/lombok) is used as a framework in order to speed up creation of container classes and builders.
|
|
* [Quartz](https://github.com/quartz-scheduler/quartz) is used as a scheduling framework in order to provide functionalities which either require a delayed or cronjob behaviour.
|
|
|
|
## Documentation
|
|
A detailed documentation of the pure form of Abstracto including the terminology and commands in HTML form is available [here](https://sheldan.github.io/abstracto-docs/). The PDF is available [here](https://sheldan.github.io/abstracto-docs/documentation.pdf)
|
|
If you want to view the documentation to an earlier released version you need to append the desired version to the URL. The current version will be available aforementioned URL, but it is not right now, because Abstracto has not been released yet.
|
|
|
|
## Customization documentation
|
|
TBD when Abstracto is released, as the current version is still being adapted, because of findings from the example customization in Crimson.
|
|
|
|
## Issues
|
|
If you find any issue, feel free to create a GitHub issue.
|
|
|
|
## License
|
|
This project is licensed under the MIT license. |