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

Commit 2b8987a

Browse files
authored
Merge pull request #17 from Riyagoel2/master
Updated README.md
2 parents bd8e5cf + c0392ac commit 2b8987a

File tree

1 file changed

+45
-31
lines changed

1 file changed

+45
-31
lines changed

README.md

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
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. This app complements [footsteps-app](https://github.com/fnplus/footsteps-app)
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.
34

45
[![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)
56
[![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)
@@ -18,36 +19,49 @@ Here are few examples of why we came up with footsteps:
1819

1920
## 🚀 Steps to setup development environment
2021

21-
- Install node, yarn/npm
22-
- Clone the repo
23-
```bash
24-
git clone github.com/fnplus/footsteps-extension.git
25-
```
26-
27-
- Install dependencies
28-
```bash
29-
npm install
30-
```
31-
or
32-
```bash
33-
yarn
34-
```
35-
- To build you code and add the extention to your chrome, run:
36-
```bash
37-
yarn run build
38-
```
39-
or
40-
```bash
41-
npm run build
42-
```
43-
and load the `/build` folder in `chrome://extensions/` on chrome (Load unpacked)
44-
45-
## 💻 Developing guidelines
46-
47-
- 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`
48-
- 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.
49-
- 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.
50-
- Write kick-ass, readable and clean code.
22+
1. **Install Node v12**
23+
24+
[**Link for Node installation (Latest LTS Version)**](https://nodejs.org/en/download/)
25+
26+
2. **Clone the repo**
27+
28+
```bash
29+
git clone github.com/fnplus/footsteps-extension.git
30+
```
31+
32+
3. **Install dependencies**
33+
34+
```bash
35+
npm install
36+
```
37+
Or
38+
```bash
39+
yarn install
40+
```
41+
42+
4. **To build you code and add the extention to your chrome, run:**
43+
44+
```bash
45+
npm run build
46+
```
47+
Or
48+
```bash
49+
yarn run build
50+
```
51+
52+
5. **Load the `/build` folder in `chrome://extensions/` on chrome (Load unpacked)**
53+
54+
## 💻 Development guidelines
55+
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`.
57+
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.
59+
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.
61+
62+
4. Write kick-ass, readable and clean code.
5163

5264
## :memo: License
5365
Licensed under the [GPL v3 License](./LICENSE).
66+
67+
## :heart: Thanks

0 commit comments

Comments
 (0)