github.com/sharovik/devbot@v1.0.1-0.20240308094637-4a0387c40516/README.md (about)

     1  # devbot
     2  [![Gitter](https://badges.gitter.im/devbot-tool/community.svg)](https://gitter.im/devbot-tool/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
     3  
     4  Free, opensource "ChatBot" project, based on GoLang. Using this project you can build your custom simple bot, which can execute the commands you need.
     5  
     6  ![demo-who-are-you](documentation/images/demo-who-are-you.gif)
     7  
     8  ## Table of contents
     9  - [How to run](#how-to-run)
    10  - [Prerequisites](documentation/prerequisites.md)
    11  - [Install to AWS](documentation/terraform-aws-setup.md)
    12  - [How to write custom event](documentation/events.md)
    13  - [How to build scenario](documentation/scenarios.md)
    14  - [How to schedule scenario](documentation/schedules.md)
    15  - [Migrations](documentation/migrations.md)
    16  - [Features out of the box](documentation/features-out-of-the-box.md)
    17  - [Internal functionalities](documentation/available-features.md)
    18  - [Events available for installation](#custom-events-available-for-installation)
    19  - [Project build](documentation/build.md)
    20  - [Authors](#authors)
    21  - [License](#license)
    22  
    23  ## How to run
    24  
    25  Build the project, [you can find the instructions here](documentation/build.md)
    26  
    27  Once project build finished, please run the following command:
    28  **For macOS and Linux**
    29  ``` 
    30  ./bin/devbot-current-system
    31  ```
    32  For windows
    33  ``` 
    34  start bin\devbot-current-system.exe
    35  ```
    36  
    37  ### Run by using docker
    38  **Before run, make sure you created `.env` file and set up the credentials**
    39  
    40  1. Build the image. To do that, please run the following command:
    41  ``` 
    42  docker build --target base -t devbot-app-base:latest .
    43  docker build --target run -t devbot-app-run:latest .
    44  ```
    45  2. If build was successful, please use the following command to run the container
    46  ```
    47  docker run --env-file=.env devbot-app-run:latest
    48  ```
    49  
    50  ### Run using docker compose
    51  Execute command `docker compose up`
    52  
    53  ## Custom events available for installation
    54  Here you can find an examples of custom events, which are ready for installation
    55  - [WordPress theme generation event](https://github.com/sharovik/themer-wordpress-event)
    56  - [BitBucket release event](https://github.com/sharovik/bitbucket-release-event)
    57  - [BitBucket run pipeline event](https://github.com/sharovik/bitbucket-run-pipeline)
    58  
    59  ## Authors
    60  * **Pavel Simzicov** - *Main work* - [sharovik](https://github.com/sharovik)
    61  
    62  ### Vendors used
    63  * github.com/joho/godotenv - for env files loading
    64  * github.com/sharovik/orm - the ORM for database queries
    65  * github.com/karalabe/xgo - for cross-platform build
    66  * github.com/pkg/errors - for errors wrapper and trace extracting in logger
    67  * github.com/rs/zerolog - for logger
    68  * github.com/stretchr/testify - for asserts in tests
    69  * golang.org/x/net - for websocket connection
    70  
    71  ## License
    72  This project licensed under the BSD License - see the [LICENSE.md](LICENSE.md) file for details