Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yashvardhan-kukreja/nail-hacktoberfest
:fire: A place where you can easily start your 'open source' journey and well, nail hacktoberfest!
https://github.com/yashvardhan-kukreja/nail-hacktoberfest
contributions-welcome hacktoberfest hacktoberfest2020 javascript nodejs open-source
Last synced: 2 months ago
JSON representation
:fire: A place where you can easily start your 'open source' journey and well, nail hacktoberfest!
- Host: GitHub
- URL: https://github.com/yashvardhan-kukreja/nail-hacktoberfest
- Owner: yashvardhan-kukreja
- License: mit
- Created: 2020-09-26T13:51:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-15T04:56:04.000Z (about 4 years ago)
- Last Synced: 2024-04-08T17:06:48.600Z (9 months ago)
- Topics: contributions-welcome, hacktoberfest, hacktoberfest2020, javascript, nodejs, open-source
- Language: JavaScript
- Homepage:
- Size: 331 KB
- Stars: 4
- Watchers: 3
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
:rocket: Let's nail Hacktoberfest 2020 the right way :rocket:
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 :sunglasses:
·
Report Bug
·
Request Feature
## Table of Contents
* [Motivation behind this project](#motivation-behind-this-project)
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Project Setup](#project-setup)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## Motivation behind this project
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 :star2: this repo. Will make me really happy :P
## About The Project
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.
### Built With
* [Node.js](https://nodejs.org/en/)
* [NPM](https://www.npmjs.com/)
## Getting Started
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.
### Prerequisites
Please setup the following tools for this project to execute successfully in your computer:
* npm
```sh
sudo apt-get install npm -y
```
* node (nodejs, whatever you call :P)
```sh
sudo apt-get install node -y
```
### Project Setup
1. Clone this repo
* With HTTPS
```sh
git clone https://github.com/yashvardhan-kukreja/nail-hacktoberfest.git
```
* With SSH (just use HTTPS if you aren't sure what SSH is)
```sh
git clone [email protected]:yashvardhan-kukreja/nail-hacktoberfest.git
```
2. Hop into the project directory
```sh
cd nail-hacktoberfest
```
3. Install NPM packages
```sh
npm install
```
4. Install the CLI
```sh
sudo npm install -g .
```
5. Run it :rocket:
```sh
nail-hacktober
```
### Docker Setup
This project can also be setup using Docker. Docker can be installed on a variety of platforms [here](https://docs.docker.com/engine/install/)
1. Clone this repo
```sh
git clone [email protected]:yashvardhan-kukreja/nail-hacktoberfest.git
```
2. Hop into the project directory
```sh
cd nail-hacktoberfest
```
3. Build the Docker image
```sh
docker build -t /nail-hacktoberfest .
```
4. Run using Docker
```sh
docker run /nail-hacktoberfest
```
## Usage
## Contributing
**Nailing the Hacktoberfest** :sunglasses:
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](https://github.com/yashvardhan-kukreja/nail-hacktoberfest/issues)
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](https://github.com/yashvardhan-kukreja/nail-hacktoberfest/blob/master/CONTRIBUTING.md)
## License
Distributed under the MIT License. See [LICENSE](https://github.com/yashvardhan-kukreja/nail-hacktoberfest/blob/master/LICENSE) for more information.
## Contact
Yashvardhan Kukreja
* [My website](https://www.yashkukreja.com/)
* Twitter - [@yashkukreja98](https://twitter.com/yashkukreja)
* Github - [yashvardhan-kukreja](https://github.com/yashvardhan-kukreja)
* Medium - [yash.kukreja.98](http://medium.com/@yash.kukreja.98)
* LinkedIn - [yashvardhan-kukreja](https://www.linkedin.com/in/yashvardhan-kukreja/)
## Acknowledgements
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Pages](https://pages.github.com)