Skip to content

Latest commit

Β 

History

History
230 lines (151 loc) Β· 13.7 KB

README.md

File metadata and controls

230 lines (151 loc) Β· 13.7 KB

Gitpod ready-to-code Open Source LoveΒ  Gitter

All Contributors

PRs WelcomeΒ  first-timers-onlyΒ  Website shields.ioΒ  Documentation StatusΒ 

πŸ‘£ Profile Extension


Gitter Channel: https://gitter.im/NWoC2020/Profext

Author License Platform Maintained Codacy Badge first-timers-only GitHub stars GitHub forks GitHub top language

A profile πŸ”Ž search engine for accessing my all social media profile in one tap.πŸ‘¨β€πŸ’»πŸ‘©β€. This chrome extension lets you track your profiles on any account in a single click.

Open Source Contests πŸ‘£

  • Student Code In 2020 πŸ‘£

    OPEN SOURCE CONTEST - STUDENT CODE IN

    About Student Code In πŸ’»

    Student Code-in is a global program that helps students grow with β€œOPEN SOURCE”. It is a 2 months long Open-Source initiative that provides you the best platform to improve your skills and abilities by contributing to a vast variety of OPEN SOURCE Projects. In this, all the registered participants would get an exquisite opportunity to interact with the mentors and the Organizing Team.

⭐ Check out the website of Student Code In 2020

  • NJACK Winter of Code 2020 πŸ‘£

OPEN SOURCE CONTEST - NWOC'20

About NWOC πŸ’»

NWoC (NJACK Winter of Code) is a program by NJACK (The Official Computer Science Club of IIT Patna) that helps students understand the paradigm of Open Source contribution and gives them real world software development experience.

NOTE: All the contributions to be counted under NWoC should be made to the develop branch.

nwoc

Mentors

Open Source Love Issues Open PRs Maintenance

GitHub Usernames Domain
@garimasingh128 Full Stack + Documentation

πŸ“‹ Table of Contents

➑️ Vision

➑️ Project Structure

➑️ Tech Stack

➑️ Setup Development Environment

➑️ Development Guidelines

➑️ Learning Resources

➑️ Simple things to keep in mind

➑️ System Requirements

➑️ Contributing

➑️ Owner

πŸ‘©β€ Vision

Getting all your social media profiles under one button click so that you don't have to manually search and do the hassle of searching your profile handles while making your resume, filling job opportunities forms, registering for events, etc.

❀️ Inspiration

This is motivated by Traversy Media tutorial on Google Chrome Extention.

🀷 Project Structure

.
β”œβ”€β”€ ...
β”œβ”€β”€ images
│── icons, logo and screenshots
│── manifest
│── popup.html
|── popup.js
|── README
└── ...

πŸ”† Tech Stack

  • HTML
  • CSS
  • JavaScript

πŸš€ Steps to setup development environment

  1. Clone the repo
git clone github.com/your_username/profext.git
  1. Open the folder in your favorite code editor and start adding modifications.
  2. Load the folder in chrome://extensions/ on chrome (Load unpacked)

πŸ’» Development guidelines

  1. Put all the code in one of the existing files in /src. If you add a new file, make a relevant modification to build.js.

  2. Push all the code to your own branch. Once you are sure it is working, merge it with the dev branch. Let's maintain only the stable and released versions on the master branch.

  3. Write a kick-ass, readable, and clean code.

  4. Load the /build folder in chrome://extensions/ on chrome (Load unpacked)

πŸ“ Learning Resources

Read these articles to get a quick grab on making Chrome extensions:

Resources to learn Git:

🧐 Simple things to keep in mind

  • The first step is to create a manifest file named manifest.json. This is a metadata file in JSON format that contains properties like your extension’s name, description, version number, and so on. In this file, we tell Chrome what the extension is going to do, and what permissions it requires.
  • To test if the extension works, visit chrome://extensions in your browser and ensure that the Developer mode checkbox in the top right-hand corner is checked.
  • Click Load unpacked extension and select the directory in which your extension files live. If the extension is valid, it will be active straight away so you can open a new tab to see your extension.
  • When your first Chrome extension looks nice and works as it should, it’s time to publish it to the Chrome Store. Simply follow this link to go to your Chrome Web Store dashboard (you’ll be asked to sign in to your Google account if you’re not). Then click the **Add new item** button, accept the terms and you will go to the page where you can upload your extension. Now compress the folder that contains your project and upload that ZIP file.
  • As a web developer, it’s very easy to create a Chrome extension in a short amount of time. All you need is some HTML, CSS, JavaScript, and basic knowledge of how to add functionality through some of the JavaScript APIs that Chrome exposes. Your initial setup can be published inside the Chrome Web Store within just 20 minutes. Building an extension that’s new, worthwhile or looks nice will take some more time. But it’s all up to you!

πŸ’» System Requirements

  • Google Chrome
  • Git
  • Code Editor (Visual Studio Code, Sublime Text)

πŸ† Contributing

Please read CONTRIBUTING.md for information on how to contribute to profext-extension.

πŸ’Ό Code of Conduct

We want to facilitate a healthy and constructive community behavior by adopting and enforcing our code of conduct.

Please adhere towards our code-of-conduct.md.

πŸ‘¬ Owner

Garima Singh

Need help? Feel free to contact me @ [email protected]

GitHub followers Twitter Follow

Codacy Badge Relative date Maintenance

built with love

Like This?? Star ⭐ this Repo.

ForTheBadge uses-git ForTheBadge uses-html ForTheBadge uses-css ForTheBadge uses-js forthebadge

Made By Garima Singh with ❀️

Garima Singh Β© 2020

ForTheBadge built-with-love ForTheBadge built-by-developers


❀️ Thanks to our awesome contributors.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Navpreet Kaur

πŸ“–

Sundaram Dubey

πŸ’»

oshinsaini

πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!