twhelp
/
dcbot-old
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #15 

chore:  update README.md
This commit is contained in:
Dawid Wysokiński 2021-06-06 19:07:30 +02:00 committed by GitHub
parent 6c0f644591 039110ee87
commit 5e03b108fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,4 +1,4 @@
# TWHelp DC Bot
# tribalwarshelp.com DC Bot
A Discord bot for the online game Tribal Wars.
@ -18,6 +18,15 @@ Features:
## Development
### Prerequisites
1. Golang
2. PostgreSQL database
3. Configured [API](https://github.com/tribalwarshelp/api)
### Installation
**Required ENV variables:**
```
@ -28,18 +37,24 @@ DB_HOST=your_pgdb_host
DB_PASSWORD=your_pgdb_password
API_URL=your_api_url
BOT_TOKEN=your_bot_token
LOG_DB_QUERIES=true|false
LOG_DB_QUERIES=true
```
### Prerequisites
1. Golang
2. PostgreSQL database
3. Configured [API](https://github.com/tribalwarshelp/api)
### Installing
1. Clone this repo.
```
git clone git@github.com:tribalwarshelp/dcbot.git
```
2. Navigate to the directory where you have cloned this repo.
3. Set the required env variables directly in your system or create .env.development file.
4. go run main.go
3. Set the required env variables directly in your system or create .env.local file.
4. Run the app.
```
go run main.go
```
## License
Distributed under the MIT License. See ``LICENSE`` for more information.
## Contact
Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)