KekFinder

A simple emoji finding tool made using ReactJS framework.

Live demo here!

Table of Contents

• Features
• Setup
• Author
• Contributing
• License

---

Features

• Built with ReactJS ✨
• All emojis available ✨
• Dark and Light theme ✨
• One page layout ✨
• Dynamic ✨
• Responsive ✨

Project setup

0. Star The Repo 🌟

Star the repo by pressing the topmost-right button to start your wonderful journey.

1. Fork it 🍴

You can get your own copy of repo keyfinder by using the fork button at the top right corner.

2. Clone it 👥

Note : Before executing these commands on your local machine you need to install git(a version control)

Clone the repo using following command:

$ git clone https://github.com/{Your-UserName}/kekfinder

This will makes a local copy of the repository in your machine. Once you have cloned the Random-Joke-Generator repository in Github, move to that folder first using following command in terminal.

# This will change the directory to the kekfinder folder 
$ cd kekfinder

3. Set-up the project 📽️

Install dependencies

npm install

Compilation and hot-reload for development

npm start

Compilation and minification for production

npm run build

4. Set it up ⬆️

Run the following commands to see that your local copy has a reference to your forked remote repository in Github.

$ git remote -v
origin  https://github.com/Your_Username/kekfinder.git (fetch)
origin  https://github.com/Your_Username/kekfinder.git (push)

Now add a reference to the original kekfinder repository using.

$ git remote add upstream https://github.com/aditya-singh9/kekfinder

This adds a new remote named upstream. See the changes using

$ git remote -v
origin  https://github.com/Your_Username/kekfinder.git (fetch)
origin  https://github.com/Your_Username/kekfinder.git (push)
upstream https://github.com/aditya-singh9/kekfinder.git (fetch)
upstream https://github.com/aditya-singh9/kekfinder.git (push)

5. Sync it ♻️

# Fetch all remote repositories and delete any deleted remote branches
$ git fetch --all --prune
# Switch to the `main` branch
$ git checkout main
# Reset the local `main` branch to match the `upstream` repository's `main` branch
$ git reset --hard upstream/main
# Push changes to your forked `kekfinder` repo
$ git push origin main

6. Ready Steady Go... 🐢 🐇

Once you have completed these steps, you are ready to start contributing, you can check already opened issues with good-first-issue tag in issues or you can create a new issue of your own.

7. Create a new branch 🌿and start working 🧑‍🏭

Whenever you are going to contribute. Always create a separate branch using command below and keep your main branch clean to avoid any conflicts.

# It will create a new branch with the name Branch_Name and switch to that branch
$ git checkout -b BranchName

Now Perform your desired changes 📝✍️

After performing your desired changes, Added your changes into staging area

$ git add .

Now commit your changes (type a short meaningful commit message that describe your changes)

# This message gets associated with all files you have changed
$ git commit -m 'relevant message'

Now push your awesome work to your remote repository

# To push your work to your remote repository
$ git push -u origin BranchName

8. Create a pull request 😎

Finally, Open the repository in browser and click on Compare and Pull Request. Then add a title and description that defines your changes then click on Create Pull Request.

9. Relax and sit Back 🍵

You've done it, now grab a coffee and wait till your pull request gets reviewed.

Author

👤 Aditya Singh

• Github: @aditya-singh9
• LinkedIn: @Aditya Singh
• Portfolio: adityasingh.xyz

🤝 Contributing

Your awesome contribution will make this project better, issues and feature requests are welcome!
Feel free to check issues page.

🎉😊 Happy Contributing. 😊🎉

📝 License

This project is under MIT License.

Project Contributors⭐