chris-burgin / bands_of_yore Goto Github PK

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!

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!

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!

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!

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.

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}
      // ****************
    """