vspedr / metal-band-generator

Randomly generates ficional metal band names and members :metal: :guitar:

Home Page:https://vspedr.github.io/metal-band-generator/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

metal-band-generator 🤘 🎸

Randomly generates ficional metal band names and members

Build Status Maintainability npm

Usage

Install with npm i band-name-generator or yarn add band-name-generator

import getBand, {
  getBandMembers,
  getBandName,
  getGenre,
  getMember,
  getMemberName,
  getMemberInstrument,
} from 'metal-band-generator';

getBand(); // returns a complete band object, with name, genre and members
getBandMembers(); // returns an array of band members
getBandName(); // returns a random band name
getGenre(); // returns a random genre
getMember(); // returns a random member, with name and instrument
getMemberName(); // returns a random member name
getMemberInstrument(); // returns a random instrument

Example band:

{ name: 'Dark Decadence',
  genre: 'Glam Heavy Atmospheric Metal',
  members:
  [ { name: 'Axl Rose', instrument: 'drums' },
    { name: 'Jorn Hetfield', instrument: 'harsh vocals' },
    { name: 'Alissa Hetfield', instrument: 'keyboard' },
    { name: 'Maria Hetfield', instrument: 'rhythm guitar' },
    { name: 'Jorn Hetfield', instrument: 'drums' },
    { name: 'Jorn Kakko', instrument: 'keyboard' } ] }

Scripts

  • build: transpiles and minifies all code in ./src into ./lib using babel;
  • lint: lints code in ./src using eslint;
  • precommit: (automatic) runs linter before every commit;
  • prepublish: (automatic) runs tests before attempting to publish the package;
  • test: runs tests in __tests__ using jest.

Metal is for everyone - Freedom Call

About

Randomly generates ficional metal band names and members :metal: :guitar:

https://vspedr.github.io/metal-band-generator/


Languages

Language:JavaScript 80.0%Language:HTML 16.3%Language:CSS 3.7%