nitdgpos / fearch Goto Github PK

Presently when user clicks on the search, extension redirects him to a new page. It would be great if the new page is formatted by injecting script. For example things like the google search bar is removed from that page, the link headings are turned into something more meaning, instead of just index of / etc.

Right now i have no way to know, how to contribute to this repo, can it be expanded so i know how to get started? thank you :) CC @PaliwalSparsh

TSIA

if any link has such a matching file give a peview on the app itself with a clickable download link

For ex: Back in black.wav , wav should be added to the predefined list of formats.

The new logo can be designed similar to the Google's logo, as the UI is also based on google home page.
The logo can be made similar to the image, replacing 'G' by 'F'.

Add links to chrome and firefox addon store in README.md

What you actually need to do

chrome app store link: https://chrome.google.com/webstore/detail/fearch/kalmlbhhgndofalfencmggfncedfajgj?hl=en
Firefox AMO link
https://addons.mozilla.org/en-US/firefox/addon/fearchit/?src=userprofile

You have to insert the above mentioned links in README.md file.

We need to update the UI as the old one is really non-intuitive in terms of feedback, followup instructions and looks ugly.

#13

Add keyboard shortcuts for selecting the different category options so that the addon can also be operated using keyboard

Right now for music we only have mp3's maybe add more options or have user-defined options? Similarly for other options. CC @PaliwalSparsh

Right now we have no way of knowing what the project is about through the Readme, some expansion is needed CC @PaliwalSparsh

Currently suggestions are hardcoded into the extension, we wish to make them more dynamic by fetching them for some internet resource.

Create a template for pull requests. It should primarily contain certain checks like whether branch is even with upstream or not, whether relevant documentations (if applied) or not, whether guidelines have been read or not, etc.

Information on creating templates can be found here

Affects firefox branch

Apart from Firefox ESR 45, developer edition and nightly versions of firefox, other versions of firefox does not allow unsigned addons to run. Firefox will disable them. This point should be made clear in CONTRIBUTING.md of the firefox branch.
Presently nothing is mentioned about installation of jpm tool. jpm is a commandline tool used to create addon template and run addon locally in a new firefox profile rather than installing the xpi file in firefox.
So to be specific the following things need to be done

In CONTRIBUTING.md of firefox branch create a new section at top named Tools required
which should look like this:

Tools required

• Firefox ESR 45 or Firefox developer edition or Firefox Nightly build
• jpm tool which can be installed from here

Description in manifest.json is incomplete, and should mention that it searches FTP servers.
Change description from -

This extension finds music,videos,books for us instantly

to

Search FTP servers over the web for music, videos, eBooks and other content.

If the user searches without selecting any checkbox in the field we should give them warning that no checkbox selected.

We intend to create a status bar towards the bottom of extension in the footer div. If user has not mentioned search query we will mention it there. If user has not ticked checkbox same for that. So basically we intend to create a feedback status bar towards the bottom of the extension. Keeping everything inside the popup window only.

We can keep an 'Others' checkbox we will search for other stuff like games, softwares.

Create and add gh-page for Fearch so that we can put it up on nitdgpOS

Add link to #general ( https://gitter.im/NIT-dgp/General ) channel in the README.md so that reaching to the maintainers is easy for newcomers.

We want to edit CONTRIBUTING.md to have this format -

shortlog: commit message

commit body

where short log is the area/filename where you make the change commit message is the very brief description of the change made by you and any other additional details go into the commit body.

Happy coding :)

to

shortlog: commit message

commit body

Fixes #21

1. shortlog is the area/filename where you make the change commit message is the very brief description of the change made by you and any other additional details go into the commit body.

2. The Fixes #<issue_no> is the issue you are working on.

3. Use the imperative mood in the subject line
   Imperative mood just means "spoken or written as if giving a command or instruction". A few examples:

• Add CONTRIBUTING.MD instead of Adding CONTRIBUTING.md
• Change the header text format instead of Changing the header text format
• Fix text box scaling instead of Fixing the text box scaling

The commit body need not have imperative mood you have independence to explain everything normally there.

Happy coding :)

No need for seperat e branches when they share so many things, just leads to duplication

from chrome-search-extension to Fearch

Presently the project code is not linted.

Project contains a grunt-eslint plugin which is to be used to see for errors in the code and fix them manually or using --fix option available in eslint.

Project is using airbnb javascript style guide.

https://github.com/NIT-dgp/Fearch/blob/8529dc10aa76234fe4d76f1fc795b3d423192d2e/CONTRIBUTING.md

Change chrome-search-extention in the first line of How to Contribute section to Fearch

The add-on is now generic as it works for both chrome as well as firefox. This should be mentioned in the README.md with information on how to setup the add-on for development on both the browsers.

Affects firefox branch

Presently when the user leaves the search field empty, or does not select any option, a warning is shown in the status area (below search field). The purpose of this issue is to make the status area a bit more eye-catching. Perhaps a different border color or an exclamation icon or anything else that makes the warning area more distinct.

right now line lengths are huge and make devs side scroll. it'll be more readable if line lenghts are shorter

Some of the FTP servers are password protected as a result, users going to the link goes in vain. If there was a way user could get to know the links were password protected on this server or these servers became invisible it would be really great.

Affects firefox branch

Presently the entire js code and css styling is present in panel.html. Since the css and js portions are not too large at present, its not a problem, but in future when css and the js portions get bigger it might become a problem, so the js and css code should be moved into different files

Affects firefox branch

Modify the search results page so that it looks similar to the search results page of chrome extension

Github picks it up. Plus people look for it :P

Inline css tend to go wild and messy as repositories grow. All the style can be moved to its own file and we can load that file using src attribute of style tag.

Create a template for submitting issues so that users do not forget to provide details like whether it is a bug or a feature request and other important information like what is the browser they are using (Chrome/Firefox) and version. Also issue template helps users/developers in reminding them important points like whether they have read the guide lines before submitting an issue or whether their branch is even with upstream etc.

Information on creating templates can be found here

Affects firefox branch

Detailed instructions about how to get the firefox extension code should be provided in the CONTRIBUTION.md file

If the user searches without giving any input in the field we should give them warning that input not present. Right now empty queries are directed to a page. We want to eliminate this behavior.

So add an if..else statement here. If query is empty then append a statement in the footer div as "No search query found." also prevent the function to redirect to new page( this would require only return; in the if statement)

In the current version, FEARCH opens the results in a new tab, so this could be modified to let FEARCH open the results in the same tab.

https://github.com/NIT-dgp/chrome-search-extension/blob/master/popup.js#L7
https://github.com/NIT-dgp/chrome-search-extension/blob/master/popup.js#L11
https://github.com/NIT-dgp/chrome-search-extension/blob/master/popup.js#L15

On these three lines go and change the == of comparison to ===

if(document.getElementById("music").checked == true)
to
if(document.getElementById("music").checked === true)

NOTE: For newcomers only. If you have already got 1 commit merged please don't attempt this issue.

Add 2 to 3 screenshots of Fearch to README.md showing the main add-on popup, results page and a ftp index page.

right now the code is unlinted and unaligned
Example: https://github.com/NIT-dgp/chrome-search-extension/blob/master/popup.html#L49 .
We need to use some linters or atleast align the code ourselve? @PaliwalSparsh what do you suggest?

We can have a suggestion box(just a small button somewhere in UI) that is dynamic and changes everytime we open the extension like one time it suggests manga other time something like pokemon and so on. For this we can make a list of things or copy from somewhere store them in the extension.

This will make the extension really dynamic and make people come back to try new things.

Although we have only one js and html file, we should keep our repo structured in any case. It will be huge help when we add more files of same type. Checkout https://github.com/ScholarNinja/extension folder organization. We need something similar. You may leave test and build folder empty for now.

basically open the top search query on a new tab

Add CONTRIBUTING.MD instead of..

should be:

Add CONTRIBUTING.md instead of

File extensions are conventionally written in small.

https://github.com/NIT-dgp/chrome-search-extension/blob/master/popup.js#L57

This is not working right now but used to work before. This made it possible to add extension to filename.