fnplus / footsteps-extension Goto Github PK

Currently, we build/transpile the code using build.sh. We need to rewrite this is in JS. Because, by making it a shell script, we are binding the development of this extension to Linux. By having the script in JS, we will be able to build this is any platform that has nodeJS installed.

The JS script can make use of the browserify APIs. This script should be written in scripts/build.js.

Is your feature request related to a problem? Please describe.
Improving the code quality from Codacy from grade B to A.

Describe the solution you'd like
Solving some issues like markdown guidelines, unexpected errors in syntax etc. to improve code quality.

@xlogix I am a GSSOC participant and I would like to add an issue template folder with pull request template and a new issue template.

Add Google, Email & Github Sign-in

Describe the bug
There are 2 code of conduct file for this repository. One should be removed.
As a GSSOC participant I would like to remove the extra Code of Conduct file.

Hello!

Greenkeeper is no longer available for new installations.

The service will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020. Find out more at greenkeeper.io.

If this is your only Greenkeeper installation, you can just sign up for Snyk directly, it’s free for Open Source even has free features for private projects as well.

Nevertheless, thanks for your interest in Greenkeeper! We’re sure your repositories will find a good home at Snyk ☀️🏡💜

All the best from everyone at Greenkeeper! 👋🤖🌴

When the extension is clicked it should be able to fetch the title and description using the meta tags of the website.

TODO

• This would be displayed on all footsteps enabled website on the top-right corner permanently
• should be extremely translucent to make sure the content underneath can be easily visible
• should become sold on hover
• should have buttons to control how this site affects the learning path. Eg: "helpful", "not helpful", "all I needed" something like that
• should look fine on all kinds of websites. (minimal, generic colors, etc)

Getting started on this:

Look at the src/content.js file. You can modify the dom(the HTML elements) from this file. So, you can directly inject the UI from here. Play around with content.js to figure out how this can be done.

GitHub Actions makes it easy to automate all your software workflows, now with world-class CI/CD.
Should i work with this as this will be very good for the project.

@xlogix should i proceed with it?

About me:-
GSSoC Aspirant.

these badges include folks, issues, pull requests and stars.

Should i work on this @xlogix

Is your feature request related to a problem? Please describe.
This repository does not have a CONTRIBUTING.md file and I would like to add it.

Describe the solution you'd like
I am a GSSOC participant and I would like to add CONTRIBUTING.md file to include the following mentioned features

• How to clone the repository
• Adding reference to the original repository
• Updating local copy of repository
• Creating a new branch
• Pushing commits
• If possible we can also include some pictures in it for a better look
• It should also include the link to the pull request template, bug report and feature request template
• Update README.md to include the link of CONTRIBUTING.md

C:\Users\User\footsteps-extension\footsteps-extension>npm run build

[email protected] build C:\Users\User\footsteps-extension\footsteps-extension
node ./scripts/build.js

C:\Users\User\footsteps-extension\footsteps-extension\scripts\build.js:10
const directoriesToCopy = ["src/auth", "src/popup/"", "public"];
^^^^

SyntaxError: Unexpected string
�[90m at wrapSafe (internal/modules/cjs/loader.js:1054:16)�[39m
�[90m at Module._compile (internal/modules/cjs/loader.js:1102:27)�[39m
�[90m at Object.Module._extensions..js (internal/modules/cjs/loader.js:1158:10)�[39m
�[90m at Module.load (internal/modules/cjs/loader.js:986:32)�[39m
�[90m at Function.Module._load (internal/modules/cjs/loader.js:879:14)�[39m
�[90m at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:71:12)�[39m
�[90m at internal/main/run_main_module.js:17:47�[39m
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] build: node ./scripts/build.js
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\User\AppData\Roaming\npm-cache_logs\2020-06-14T04_39_48_951Z-debug.log

We need to make a wrapper for querying the graphql engine which will serve the data. We can make it a library which will wrap something like apollo and expose easy to use functions for the extension to call. Put this library in src/lib/

We need to be able to authenticate users into the extension using google/other social auth. We can use firebase to do this (Or anything else you think would be better).

• Opening the popup for the first time should show the social login buttons.
• Clicking them would redirect the user to follow the regular social login flow and finally redirect to the actual popup with the form
• This form should only be shown if the user is logged in
• And when the user is logged in, we should skip the login part (obviously)

When the extension icon is clicked, a popup should show with options to view/edit the whitelisted/blacklisted domains and other settings

Need to set up a base class for a parser. So that we can inherit it for creating parsers individually for different websites.

Hey,
Can I work on this issue and make a file specifying guidelines of how to contribute in the project.
I have provided it's short description which can be linked to this page for futher information @xlogix