This repo contains opinionated recommendations and suggestions as to the tools that many frontend developers (especially beginners) will find useful.
Beginners may also find dev-env-git
recommendations useful.
All scripts are optional. It is recommended that you look into the script of your choice before using it.
Some tools/scripts are specific to Windows OS (as denoted). Under Windows scripts are intended to get launched under e.g. Git Bash that comes bundled with git distribution. Under Windows it is accessible from file explorer context menu.
Scripts may require you to fix filepath, credentials, etc (as denoted).
Some scripts will require administrative privileges
and need to be set as executable (just run chmod u=rwx *.sh
is this project folder).
Remember to precede script with explicit path when launching them,
e.g. ./script.sh
If you are at the very beginning of the profession you may
also find dev-env-git
project useful to make your life easier.
Install the following
- Node Version Manager for
Windows
or Linux/Mac
(trust me, you will need it) and run
./bash-nvm.sh - node.js+npm
- Optional: yarn or pnpm;
Worth reading:
npmvsyarnvspnpm;
A note re
pnpm: Under Windowspnpmmay require that packages repository and projects are located on the same hard drive (pnpmuses hard links, and Windows poses certain restrictions; please, google for details or trust the above)
Some frontend tools may require building and under Windows you may
require extra tools for this. The most popular add-ons that will
require building from source are:
node-sass,
bcrypt,
sqlite3,
serialport,
websocket,
deasync,
grpc,
canvas,
sharp,
hiredis,
leveldown,
nodegit,
zqm,
ffi,
libxmljs,
iconv,
ref,
sleep,
microtime,
couchbase,
bignum,
kerberos, and
ursa.
The list is taken from
windows-build-tools
project.
Install python 2.7
Install OS speific toolchain as per sections below.
Consult node-gyp
and/or windows-build-tools
to resolve any issues you may face.
Execute ./windows-build-tools.sh or
run commands from therein manually.
Execute xcode-select --install in your Terminal.
Install GCC. Here is a guide for Ubuntu 18.04. Google for a similar guide matching your OS flavour.
utils-*.sh scripts offer a couple of useful node scripts. Run either of
the two scripts based on your package manager preference
(run ./utils-npm.sh when in doubt)
as admin (e.g. sudo ./utils-npm.sh).
The script will install:
doctoc automates Table Of Contents (TOC)
creation for MD files. TOC in this repo README.md is created using doctoc.
How to use:
- add a placeholder
<!-- START doctoc -->\n<!-- END doctoc -->in an.mdfile at a location you want TOC be placed at - execute
doctoc README.md --githubin Terminal to create or update TOC
push-dir pushes a subtree to
a given branch on remote. Useful to publish with GitHub Pages a built
web app only.
How to use:
- run
push-dir --dir=dist --branch=gh-pagesto publish only what is built; normally it is./distdirectory, which is also ignored (via.gitignore) and never tracked by git - add a script to your
package.jsonscriptssection to publish a web app on e.g. github pages:"publish": "push-dir --dir=dist --branch=gh-pages --cleanup --verbose"
When added a script to package.json then npm build && npm run publish
(or yarn build && yarn run publish) will normally build and publish
an app on GitHub Pages (provided of course build script is also set up).
If anything above contains errors, not quite clear or requires improvement or update, please, feel free submitting an Issue.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent