Requirements
- Brew ( Video: How to Install )
- NodeJS ( Video: How to Install )
With Brew already installed you can run the following commands to install MongoDB, setup your database folder, and assign the correct permissions to it.
Note: MongoDB Installation is required but you can skip if you already have it installed.
brew install mongodb
sudo mkdir -p /data/db
sudo chown -R $(whoami): /data
Fork this repo onto your own github account.
In the top-right corner of this page, click Fork
Clone your forked repo to your laptop.
This will download the files into your current folder in terminal. Make certain to navigate to a folder where you want this project to live.
git clone your_forked_repo_url
Install the dependencies. Navigate to your code via terminal and command:
npm install
Additional Global Installs to make your life easier.
npm i -g nodemon
Obtain @spambot's Bot Token from the #slack_hack_night channel on wdd.slack.com.
Create an .env file on the root of your project with the token.
echo "BOT_TOKEN=paste_your_bot_token_here" > .env
Start your MongoDB server in a separate terminal window.
mongod
Start the bot.
nodemon src/server.js
A majority of your testing should occur through Direct Messages with @spambot. If your feature needs to be tested in a room please use the room #slack_hack_night. Note that multiple devs will be using the same bots, therefor you may get some of their testing data or output. As a matter of courtesy try to set your bot to trigger only on commands related to your feature.
Add your functionality as a new script within src/controllers/ and require it into src/server.js. If you need to make any adjustments to the main server file, or add to src/models/ go for it! Just be aware you are at a higher risk of merge conflicts.
Developers will be testing on @spambot. As your feature is completed and ready to promote to staging make a pull request to this repo, once merged in it will automatically deploy to @phishbot. At the end of the Hack Night we will revise the final code and push to production and your scripts will live on in infamy under @hal.
| Bot | Environment |
|---|---|
| @hal | Production |
| @phishbot | Staging |
| @spambot | Development |