Skip to content
This repository was archived by the owner on Mar 10, 2021. It is now read-only.

Commit 4fc5622

Browse files
committed
Chore: Update project & readme
1 parent 2b8987a commit 4fc5622

File tree

5 files changed

+93
-90
lines changed

5 files changed

+93
-90
lines changed

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# 👣 Footsteps Extension
2-
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.
3-
This app complements [footsteps-app](https://github.com/fnplus/footsteps-app) . The browser extension for Footsteps App helps you to quickly save your learning footsteps with a click of a button.
42

5-
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ffnplus%2Fproject-footsteps-chrome.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Ffnplus%2Fproject-footsteps-chrome?ref=badge_shield)
3+
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.
4+
This app complements [footsteps-app](https://github.com/fnplus/footsteps-app) . The browser extension for Footsteps App helps you to quickly save your learning footsteps with a click of a button.
5+
6+
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub. com%2Ffnplus%2Fproject-footsteps-chrome. svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub. com%2Ffnplus%2Fproject-footsteps-chrome?ref=badge_shield)
67
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d4e157de374b4db4a5277592bd6f4d7e)](https://www.codacy.com/manual/fnplus/footsteps-extension?utm_source=github.com&utm_medium=referral&utm_content=fnplus/footsteps-extension&utm_campaign=Badge_Grade)
78
[![CodeFactor](https://www.codefactor.io/repository/github/fnplus/footsteps-extension/badge)](https://www.codefactor.io/repository/github/fnplus/footsteps-extension)
89

910
## 🤷 About
10-
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.
1111

12-
With Footsteps [app](https://github.com/fnplus/footsteps-app) & [browser extension](https://github.com/fnplus/footsteps-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.
12+
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.
13+
14+
With Footsteps [app](https://github.com/fnplus/footsteps-app) & [browser extension](https://github.com/fnplus/footsteps-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.
1315

1416
## 🧐 The Need (as seen on the web)
1517

@@ -20,48 +22,52 @@ Here are few examples of why we came up with footsteps:
2022
## 🚀 Steps to setup development environment
2123

2224
1. **Install Node v12**
23-
2425
[**Link for Node installation (Latest LTS Version)**](https://nodejs.org/en/download/)
25-
26-
2. **Clone the repo**
27-
26+
27+
2. **Clone the repo**
28+
2829
```bash
2930
git clone github.com/fnplus/footsteps-extension.git
3031
```
3132

3233
3. **Install dependencies**
3334

34-
```bash
35+
``` bash
3536
npm install
3637
```
37-
Or
38-
```bash
38+
39+
Or
40+
41+
``` bash
3942
yarn install
4043
```
41-
44+
4245
4. **To build you code and add the extention to your chrome, run:**
43-
44-
```bash
46+
47+
``` bash
4548
npm run build
4649
```
47-
Or
48-
```bash
50+
51+
Or
52+
53+
``` bash
4954
yarn run build
5055
```
51-
52-
5. **Load the `/build` folder in `chrome://extensions/` on chrome (Load unpacked)**
56+
57+
5. **Load the `/build` folder in `chrome://extensions/` on Chrome Browser (as Load unpacked)**
5358

5459
## 💻 Development guidelines
5560

56-
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`.
61+
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` .
5762

58-
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.
63+
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.
5964

60-
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.
65+
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.
6166

62-
4. Write kick-ass, readable and clean code.
67+
4. Write kick-ass, readable and clean code.
6368

6469
## :memo: License
65-
Licensed under the [GPL v3 License](./LICENSE).
70+
71+
Licensed under the [GPL v3 License](. /LICENSE).
6672

6773
## :heart: Thanks

package-lock.json

Lines changed: 61 additions & 64 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"license": "MIT",
77
"private": false,
88
"devDependencies": {
9-
"browserify": "^16.5.0",
10-
"fs-extra": "^8.1.0"
9+
"browserify": "^16.5.1",
10+
"fs-extra": "^9.0.0"
1111
},
1212
"scripts": {
1313
"build": "node ./scripts/build.js"

scripts/.DS_Store

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)