EddieBot
Inclusive words Discord bot (no more "hey guys")
File Explorer
Download Latest Version (.zip)- bug.yml
- config.yml
- docs.yml
- ideas.yml
- other.yml
- pull.md
- build.yml
- codeql.yml
- deploy.yml
- docker.yml
- kubescape.yml
- release.yml
- FUNDING.yml
- Dockerfile
- .gitignore
- commit-msg
- pre-commit
- deployment.yaml
- stripSpecialCharacters.test.ts
- checkBannedWords.ts
- checkContent.ts
- stripSpecialCharacters.ts
- help.ts
- stats.ts
- version.ts
- AlexJsOptions.ts
- BannedWordsOptions.ts
- DictionaryOptions.ts
- IntentOptions.ts
- UrlRegex.ts
- ServerConfig.ts
- Statistics.ts
- Warnings.ts
- connectDb.ts
- _handleEvents.ts
- onDelete.ts
- onInteraction.ts
- onMessage.ts
- onUpdate.ts
- Command.ts
- ExtendedClient.ts
- checkLinks.ts
- dictionaries.md
- en_US.aff
- en_US.dic
- typoFixer.test.ts
- errorHandler.ts
- getAlexConfig.ts
- getBannedWordConfig.ts
- loadCommands.ts
- logHandler.ts
- registerCommands.ts
- typoFixer.ts
- validateEnv.ts
- main.ts
- .dockerignore
- .env.example
- .gitignore
- .gitpod.yml
- .prettierrc
- captain-definition
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- commitlint.config.js
- CONTRIBUTING.md
- Dockerfile
- eslint.config.mjs
- jest.config.ts
- LICENSE
- mongo-compose.yml
- package-lock.json
- package.json
- README.md
- SECURITY.md
- tsconfig.build.json
- tsconfig.json
# Installation Guide
1. Get the code
git clone https://github.com/EddieHubCommunity/EddieBot
Downloads the entire project code from GitHub to your computer.
cd EddieBot
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f .gitpod/Dockerfile -t eddiebot .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 eddiebot
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
$ npm ci
Type this command into your terminal and run it.
$ npm run build
Builds optimized production files.
$ npm start
Starts the development/run server.
$ npm test
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)