vfreitas- / nail-hacktoberfest Goto Github PK

Your one-stop place for diving into the world of Open Source Dev by learning and making "legit" open source contributions with ease and most importantly, fun!
And meanwhile, cracking the hacktoberfest 2020 too 😎

· Report Bug · Request Feature

• Motivation behind this project
• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Project Setup
• Usage
• Contributing
• License
• Contact
• Acknowledgements

Hacktoberfest 2020 has begun. And well, we all want T-shirts and stickers all the way from Github. But well, this time let's "actually" make some kickass PRs, learn truly about the titbits of open source dev.
And this project is gonna make you do that.
This project involves guides and fully explained and exemplified steps to contribute to this (or essentially any other) open source repository the right way

Let me say two things:

• It's incredibly easier than it looks.
• Once you get even 1 single PR merged in this repository, you would already be versed with some nice open source practices.

Now, jump to the next section to know about this project and realise how easy it is (and even to contribute to it).

If you like this idea and project, then do 🌟 this repo. Will make me really happy :P

Now, coming to this project and its functionality. This is an extremely simple CLI (command-line-interface) which will give you random fun facts related to computer science, programming or whatever.
The facts are contained within the code itself (here lies your contributions' opportunities ;) ) , hence, you don't need internet access to get those facts.

Later on, we can look forward to adding any other add-ons like jokes, quotes, and what not.

The idea is to bring you to the open source community and make you contribute to it and learn lots and lots.

• Node.js
• NPM

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Please setup the following tools for this project to execute successfully in your computer:

• npm

sudo apt-get install npm -y

• node (nodejs, whatever you call :P)

sudo apt-get install node -y

1. Clone this repo

git clone [email protected]:yashvardhan-kukreja/nail-hacktoberfest.git

2. Hope into the project directory

cd nail-hacktoberfest

3. Install NPM packages

npm install

4. Install the CLI

sudo npm install -g .

5. Run it 🚀

nail-hacktoberfest

Nailing the Hacktoberfest 😎

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Checkout the issues here

For getting a detailed explanation and guide to contributing to this repo (or essentially any repo) the right way in under 5-10 minutes, please refer to CONTRIBUTING.md

Distributed under the MIT License. See LICENSE for more information.

Yashvardhan Kukreja

• My website
• Twitter - @yashkukreja98
• Github - yashvardhan-kukreja
• Medium - yash.kukreja.98
• LinkedIn - yashvardhan-kukreja

• GitHub Emoji Cheat Sheet
• Choose an Open Source License
• GitHub Pages