This bot does nothing useful right now.
You need to set up your development environment before you can do anything.
Install Node.js and NPM
- on OSX use homebrew
brew install node
Fork or download this project.
Then copy the .env.example file and rename it to .env. In this file you have to change the TOKEN variable to be your bot's token.
Instructions on how to create a bot can be found on Discord's developer website.
Then setup your application environment.
npm installThis installs all dependencies with npm.
Go to the project dir and start your app with this npm script.
npm run devThis starts a local server using
nodemon, which will watch for any file changes and will restart the sever according to these changes.
If you get an error regarding sodium, install the following dependencies:
brew install libtool autoconf automake- Install all dependencies with
npm install
This project conforms to StandardJS code style and will fail to build if you have any linter errors. Install the ESLint Visual Studio Code plugin to show errors.
- Run code quality analysis using
npm run lint. This runs eslint. - This is also run in the pre-test hook for npm.
- Run the unit tests using
npm test. This also runs eslint.
- Run
npm run devto start nodemon to serve the app.
This project uses Travis CI to perform continuous integration. When code gets merged into master, it is immediately deployed to Heroku. In order to maintain a working master branch, pull requests built and tested using Travis CI and must have passing build prior to merging.
Run the following script before making commits.
npm test
| Name & Link | Description |
|---|---|
| DiscordJS | discord.js is a powerful node.js module that allows you to interact with the Discord API. |