/footsteps-extension

The companion browser extension for footsteps.dev. The project has been moved to a new repo.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

👣 Footsteps Extension

This app complements footsteps-app . The browser extension for Footsteps App helps you to quickly save your learning footsteps with a click of a button.

A search 🔎engine for community-made 🧑‍🤝‍🧑learning resources for the 21st-century learner. 👨‍💻👩‍💻Learn by following the footsteps (resources) of experts or make your own, giving others the right advice/resources to learn. This chrome extension let's you track your learning footsteps and also inspire others to follow them. This app complements footsteps-app . The browser extension for Footsteps App helps you to quickly save your learning footsteps with a click of a button.

FOSSA Status Codacy Badge CodeFactor

🤷 About

We envisioned the project to solve the problems faced by 21st-century learners. A modern learner finds a flood of resources from Google Search but doesn't always find the right resources since it's the website with the best SEO (search engine optimisation) that wins. There are so many free resources available on the internet made by experts in their field and yet we pay for outdated courses promoted by big companies and universities.

With Footsteps app & browser extension, we take a mentor/subject knowledge expert first approach to solve the problem. The domain experts save their learning journey with our app and browser extension & make it available for everyone else to follow. Every resource is called a 'footstep' (added in a chronological manner) and a collection of footsteps makes up a learning path. The learner can "fork" the learning path made by the expert and keep a track of his progress. The app suggests resources & keeps an updated list with users upvotes & collaborative filtering.

🧐 The Need (as seen on the web)

Here are few examples of why we came up with footsteps:

Reddit thread - "About IBMs Data Science Certification"

⏪ Prerequisites

  • NodeJS (check for it's installation on terminal using npm -v)

🚀 Steps to setup development environment

  1. Install Node v12 Link for Node installation (Latest LTS Version)

  2. Clone the repo

git clone github.com/fnplus/footsteps-extension.git
  1. Install dependencies
npm install

Or

yarn install
  1. To build you code and add the extention to your chrome, run:
npm run build

Or

   yarn run build
  1. Load the /build folder in chrome://extensions/ on Chrome Browser (as 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 relavent modification to build.js .

  2. If you want to modularize the code, use the /src/lib folder. Put all the modules there and require() them from /src . This will not need any modification to the build.js file.

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

  4. Write kick-ass, readable and clean code.

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

🏆 Contributing

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

👨 Owner

Abhishek Uniyal

👬 Mentors

Abhishek Uniyal

Arjun Mahishi

📜 License

Licensed under the GPL v3 License.

❤️ Thanks