chris-burgin / bands_of_yore

Tweet bot inspired by D&D. Keeps you up to date on your favorite bands of lore.

Bands of Yore

Bands of Yore is a node bot that tweets fictional band names inspired by Dungeons and Dragons. This repo contains the source code for the twitter bot. Check out the bot at @bandsofyore.

Requirements

• Node 8.3.0 or Greater

Install

Clone The Repo

git clone https://github.com/chrisburgin95/bands_of_yore.git

Twitter Environment Variables

Setup the following environment variables for your twitter API access. You can do that at https://apps.twitter.com/.

• CONSUMER_KEY
• CONSUMER_SECRET
• ACCESS_TOKEN_KEY
• ACCESS_TOKEN_SECRET

Run The Application

node index.js

Contributing

Check out the issues on how to contribute to this project. There are issues specifically designated for first-time contributors or someone new to Javascript and Node.

Adding to the Dictionary

Check out ./app/data and follow the existing syntax to contribute to the dictionary of words that application uses to create tweets. This is a great location to begin contributing.

As a note it will help to understand javascript Template Literals when looking at the dictionary. It is also important to note that at a base level all tweets are constructed from [noun] and [adjective] with the ability to create sub components such as [band] and [venue] that are then inserted into [tweet].

bands_of_yore's Issues

Add Conjunctions

Add the ability for conjunctions to be used inside both components and tweets.

This is an easy addition of you trace [noun] through the project.

Add More Tweets

If you look in /app/data/tweets.js you will see an array of objects.

{
    data: "[band] [venue]",
    build: arr => `Catch ${arr[0]} playing at ${arr[1]}!`
}

This is a home made template system. The first line data can be any of the following [band] [venue] [noun] [verb] [adjective]. The second line is the tweet with the above items being inserted via template strings. Take a minute to look at the file and its fairly easy to understand whats going on once you understand template strings.

There are currently only two tweets in here. Create at least one new tweet and submit a pull request! Remember to have fun and be creative!

Add More Nouns

In /app/data/nouns.js add more nouns that might be used in the olden times. The nouns are a held in an array. It will be very easy and simple to add them!

Requirements

• Have fun!
• Be Creative!

Add More Verbs

In /app/data/verbs.js add more verbs that might be used in the olden times. The verbs are a held in an array. It will be very easy and simple to add them!

Requirements

• Have fun!
• Be Creative!

Document Function

Is in need of some function documentation at app/functions/*.js. Ideally it will follow the below format for function documentation.

// ****************
// functionname()
// use: what your function does
// returns: what your function returns
// ----------------
// variable name: required/optional - type - what_its_used_for
// ****************

In files that currently have an existing function block (as seen below). Replace that function block with the new above function block.

// ****************
// Function
// ****************

---

If you want to make this a snipit in your editor I have listed both atom and vscode below

VsCode

"fucntionBlockComment": {
  "prefix": "bcf",
  "body": [
    "// ****************",
    "// ${functionname()}",
    "// use: ${what your function does}",
    "// returns: ${what your function returns}",
    "// ----------------",
	"// ${variable name}: ${required/optional} - ${type} - ${what_its_used_for}",
	"// ****************"
  ],
  "description": "Block Comment for Function"
}

Atom

'Function Block Comment':
    'prefix': '//fn'
    'body': """
      // ****************
      // ${1:functionname()}
      // use: ${2:what your function does}
      // returns: ${3:what your function returns}
      // ----------------
      // ${4:variable name}: ${5:required/optional} - ${6:type} - ${7:what}
      // ****************
    """

Add More Adjectives

In /app/data/adjectives.js add more adjectives that might be used in the olden times. The adjectives are a held in an array. It will be very easy and simple to add them!

Requirements

• Have fun!
• Be Creative!