Skip to content

Latest commit

 

History

History
122 lines (99 loc) · 4.03 KB

README.md

File metadata and controls

122 lines (99 loc) · 4.03 KB
Raw

inspireNuggets

A Chrome Extension that displays random inspiring techie quotes for developers/designers. 🔥

Contributors Guide

Prerequisites

  • Git or any equivalent Version Control System (GitKraten, GitHub Desktop e.t.c)
  • Code Editor (VsCode, Atom e.t.c)
  • Little Bash command line knowledge
  • Basic JavaScript knowledge

Getting Started

  1. If you are new to Git and Github, it is advisable you go through GitHub For Beginners before moving to the next step.

  2. Fork the Repository here

  3. Clone the forked Repository
    $ git clone https://github.com/BolajiAyodeji/inspireNuggets.git

  4. Enter the cloned directory
    cd inspireNuggets

  5. Open directory in your Code Editor
    code .

  6. Load the extension in Developer's Mode as 'UnPacked'

    • Open your Chrome Browser
    • Click on the three dots at the upper right corner of your tab
    • Select More Tools
    • Select Extensions
    • Click on the Load UnPacked button at the upper left corner
    • Locate the directory you cloned the repository to and Click OK
    • Now the Extension should be added to the list in Developer's Mode
    • Open a New Tab to preview the extension
    • Now when you make changes to the cloned repository, this Unpacked Extension would be updated

All Quotes are stored in a JSON file which can be found here src/quotes.json Quotes are stored in this format

[
    {
        "number": "1",
        "author": "Von R. Glitschka",
        "quote": "The client may be king, but he's not the art director."
    },
    {
        "number": "2",
        "author": "Frank Capra",
        "quote": "A hunch is creativity trying to tell you something."
    },
    {
        "number": "3",
        "author": "Ernest Hemingway",
        "quote": "Write drunk; edit sober."
    }
]

To add a new Quote this Extension; you need to add the Quote to the JSON file

STEP ONE

  • Every Quote has a designated number, so check the number of the last quote before we proceed
  • You should have your quote and author name already
  • Quotes are in this format
{
        "number": "1",
        "author": "John Doe",
        "quote": "Loorem ipsum dolor sit amet consectetur adipisicing elit.."
},
  • The last quote does not end with a , after the curly brackets }
  • Any quote before the last quote ends with a ,
  • To add your quote; first add a , to the last quote after the curly bracket }
  • Copy and paste this code after the last quote before the ]
{
        "number": "1",
        "author": "John Doe",
        "quote": "Loorem ipsum dolor sit amet consectetur adipisicing elit.."
}
  • Now edit that code snippet to show your own quote;
    (Change the number to the last number, add your Author name and Quote)

STEP TWO

  • Push your files 
$ git add --all
$ git commit -m "commit description here"
$ git push -u origin master
  • Open a Pull Request ( What is a pull request? )
  • Add enough description of what you did, changes you made and if possible screenshots
  • Wait for Review (Your PR would be reviewed and merged if deemed fit)

Helpful Resources

If you are not a Developer and still want to add a/your Quote to this Extension fill this form and it would be added.

This Guide is Open for Updates, if you feel it is not complete or you have ideas of what should be added, Follow the same format above. This file is stored in docs/README.md Update as you deem fit and send a Pull Request.

Author

Bolaji Ayodeji

Licence

MIT