Giter Club home page Giter Club logo

everydayfun's Introduction

Everyday Fun - Hacktoberfest 2020

A simple NPM package which can return everyday quotes, jokes, riddles and interesting facts.
Click here to view this package on NPM registry.

Everyone is encouraged to participate, regardless of your skill level as it is especially for first timers and beginners. Use this project as a motivation to enter the world of Open Source Softwares.

Installation

NPM

npm

Make sure to download and install Node.js.
Now, install the node js module using the following command:

npm i everyday-fun

Usage

const all = require("everyday-fun");

console.log(all.getRandomQuote());

console.log(all.getRandomJoke());

console.log(all.getRandomRiddle());
  • getRandomQuote() returns an object containing quote and author -
{
      "quote":"Don't cry because it's over, smile because it happened.",
      "author":"Dr. Seuss"
}
  • getRandomJoke() returns an object containing body and category -
{
      "body":"Paddy and Mick were standing at a road junction,they spotted a truck carrying aload of rolled up lawn turfPaddy says to Mick \"aye thats what i,m going to do when I win the lottery\"Mick says \"whats that then Paddy?\"Paddy replies \"send my grass away forcutting\".",
      "category":"Men"
}
  • getRandomRiddle() returns an object containing riddle and answer -
{
    "riddle": "Thirty white horses on a red hill, First they champ, Then they stamp, Then they stand still. ",
    "answer": "Teeth"
}

Want to contribute?

Please find issues here.

Expectation from you:

  • Some basic Git knowledge.

System requirements:

  • Make sure node version 10 or higher is installed on your system.

  • Make sure npm version 6.14.4 or higher is installed on your system.

How to Contribute

Note 1: If you've never made a pull request before, or participated in an open-source project, we recommend taking a look at this wonderful video tutorial. And if you want a more complete tutorial on using github, creating branches etc. , here's a detailed video series.Once you've got your feet wet, you're ready to come back and dive into Hacktoberfest fun!

Note 2: Super Important Only the pull requests created between October 1st, 2020 and October 31st, 2020 will be counted!

  1. Star this repository. ๐Ÿ˜›

  2. And then you have to fork (make a copy) of this repo to your Github account.

  3. Clone (download) your fork to your computer.

  4. Set your streams so you can sync your clone with the original repo (get the latest updates)

  5. Create a branch with your name (for e.g: if your name is Bruce Wayne, create a branch named Bruce_Wayne).

  6. Make the changes in your branch.

  7. Commit and push the code to YOUR fork.

  8. Create a pull request to have the changes merged into the origin.

everydayfun's People

Contributors

tachodril avatar harshaldesai01 avatar bsantosh909 avatar kumaravel95 avatar siddharthshukla547 avatar aleczzzzz avatar ashitajain14 avatar banerjee-suchismita avatar lemuellloren avatar rppacleb avatar arnoldtherigan15 avatar stebogit avatar nishathapa avatar najem-nabhani avatar ephremdeme avatar djgovani avatar akash52 avatar rajkhatana avatar ryanadhi avatar sycoraxx avatar teyim avatar suharu avatar agungleksono avatar darkpanda08 avatar hahahandroid avatar ibecer avatar jbdevera avatar keshavbantu avatar manthanabc avatar mitali-datascientist avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.