syed-rafi-naqvi/project-footsteps

The chrome extension that let's you track your learning footsteps and also inspire others to follow them

Footsteps

The chrome extension that let's you track your learning footsteps and also inspire others to follow them

Steps to setup development environment (only linux)

• Install node, yarn/npm
• Clone the repo

  git clone [email protected]:fnplus/footsteps.git

• Make the build script executable

  chmod +x build.sh

• Install dependencies

  npm install

  or

  yarn

• To build you code and add the extention to your chrome, run:

  yarn run build

  or

  npm run build

  and load the /build folder in chrome://extensions/ on chrome (Load unpacked)

Developing guidelines

• Put all the code in one of the existing files in /src. If you add a new file, make a relavent modification to build.sh
• 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.sh file.
• 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.
• Write kick-ass, readable and clean code.