No description
Ethan Lane
2ac2737bc0
# Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. #492, #493 ## Type of change Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update # How Has This Been Tested? Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration. # Checklist - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that provide my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules Reviewed-on: #503 Reviewed-by: VylpesTester <tester@vylpes.com> Co-authored-by: Ethan Lane <ethan@vylpes.com> Co-committed-by: Ethan Lane <ethan@vylpes.com> |
||
|---|---|---|
| .forgejo/workflows | ||
| .gitea | ||
| .github | ||
| data | ||
| database | ||
| docs | ||
| scripts | ||
| src | ||
| tests | ||
| .dockerignore | ||
| .drone.yml | ||
| .env.example | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| docker-compose.yml | ||
| jest.config.json | ||
| jest.setup.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| renovate.json | ||
| tsconfig.json | ||
| yarn.lock | ||
VylBot App
Discord bot for Vylpes' Den Discord Server.
Installation
Download the latest version from the releases page.
Copy the config template file and fill in the strings.
Requirements
- NodeJS v16
- Yarn
Usage
Install the dependencies and build the app:
yarn install
yarn build
Setup the database (Recommended to use the docker-compose file)
docker-compose up -d
Copy and edit the settings files
cp .env.template .env
# Edit the .env file
cp ormconfig.json.template ormconfig.json
# Edit the ormconfig.json file
NOTE: Make sure you do not check in these files! These contain sensitive information and should be treated as private.
Start the bot
yarn start
Alternatively, you can start the bot in development mode using:
yarn start --dev
Dev mode ensures that the default prefix is different to the production mode, in case you have both running in the same server.