bdatdo0601/dabotboi repository overview
Discord-Bot-Boi
Utility Discord Bot (DaBotBoi) built for primarily for The Gang Discord channel.
Prerequisites
Some of these are opinionated!!
If you know what you are doing, feel free to use your own tools
Core
Ensure you can run these programs from your terminal/shell
- Node (v10.12.0 or higher): Allow running JavaScript code to run directly on computer instead of just through browser
- Yarn Package Manager: Manage Node's libraries
Development
The Project is developed using TypeScript, basically JavaScript with some twist
- Visual Studio Code: IDE to develop. Have a tons of package to support writing
goodcode
Contribution
- Git: Version control, allow seamless collaboration on projects
Installation
- Open your terminal/shell and clone (or Download and Unzip) the project
$ git clone https://github.com/bdatdo0601/Discord-Bot-Boi.git
- Locate to the root of the project and install dependencies with Yarn
$ cd Discord-Bot-Boi/
$ yarn
- setup
.envat the root of the project to set required environment variable(refer to.sample-envfor example)
Usage
Below are availabe command for the project. Checkout package.json to see the exact command executed:
$ yarn lint # cleaning up source code
$ yarn start # start the project in development mode
$ test:specific # test specific file
$ yarn test # run test against the project
$ yarn build-server # compile project into production version
$ yarn coverage # update the coverage status of the project
$ yarn clean # clear build folder
$ yarn build # clear build folder and compile project to production version
$ yarn start-production # start the project in production mode
$ yarn deploy # build the project and start it in production mode
Testing
To get coverage status for the project from local machine, setup .coveralls.yml with repo_token from coveralls.io
Testing Area
This is the testing area for the discord. By default, everyone who joins will be adminstrator so they can fully play around. With that being said, please do not destroy the server.
Project Directory
.
├── LICENSE # License for the project
├── Procfile # Heroku configuration (use for deployment)
├── README.md
├── build/ # Storing the production (compiled) version of the project
├── coverage/ # Coverage Report (How well-tested the project is)
├── package.json # Project Configuration (declare dependencies, scripts, etc)
├── src/ # Source code folder
│ ├── commands/ # commands that are available to use
│ │ ├── command.interface.ts # Interfaces to ensure static typings
│ │ ├── index.ts # Starting point of this (sub)directory
│ │ ├── mock/ # Example command
│ │ │ └── index.ts
│ ├── events/ # Discord event management
│ │ ├── event.interface.ts
│ │ ├── index.ts
│ │ ├── message/ # Example event
│ │ │ └── index.ts
│ ├── lib/ # Utility functions
│ │ └── api/
│ │ └── reddit/ # Example utility for RedditAPI
│ │ ├── index.ts
│ │ └── reddit.interface.ts
│ ├── res/ # Static Resources
│ ├─── typings/ # TypeScript Typings for external, untyped JS Module
│ │ └── declarations/ # Declaration Files
│ │ └── json.d.ts
│ └─── index.ts # Starting point of the entire project
├── test/ # Automated testing
├── tsconfig.json # TypeScript Configuration
└── yarn.lock
Contribution
Feel free to create issues to request new feature or fork the project and create pull requests.
Tag summary
Content type
Image
Digest
Size
158.6 MB
Last updated
almost 8 years ago
docker pull bdatdo0601/dabotboi