This document contains various sections to help a developer be be initiated on various projects easily.
This readme contains following sections:
- Tools Installation
- Project Setup
- Project Development
Note: Wherever you find command to be executed, you'll need to execute it in a terminal. When executing, ensure that there are no periods or extra spaces at the end of command.
Most of projects in 91springboard are Javascript based and you'll need following tools to begin with.
Depending upon your operating system (Windows, Linux, or MacOS) and bit version (32 bit or 64 bit), install the following tools:
- Git: Git is a free and open source distributed version control system. Git is also used by npm and bower package managers to install project's development and code dependencies.Refer to the links below to get idea about git(theory + commands).
--> https://codeburst.io/git-and-github-in-a-nutshell-b0a3cc06458f
--> https://github.com/joshnh/Git-Commands
-
NVM: Simple bash script to manage multiple active node.js versions. Node Version Manager (nvm) is a tool that allows you to manage multiple versions of Node.js on the same machine. Each version runs in its own isolated environment, so you can safely switch versions without affecting the whole system. Refer the link below for NVM Youtube tutorial .
-
Node: Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node also contains npm package manager which is used to download project dependencies. Use nvm to install a particular node version.Refer to the link of youtube tutorial given below:
https://www.youtube.com/watch?v=uVwtVBpw7RQ
-
Bower: Bower is a package manager to download and manage code dependencies.
Execute
bower -v
. If it shows a version it means bower is already installed. If not, executenpm install -g bower
to install bower globally.Check out the link below:https://www.youtube.com/watch?v=eXv_KG9SAzw
Bower is installed using NPM (NPM has already been installed along with Node in the above step).
-
JSDoc: JSDoc is an API documentation generator for JavaScript.
Execute
npm install -g jsdoc
to install JSDoc globally because JSDoc will be used in many projects to generate HTML version of code documentation. -
BitBucket's SourceTree: SourceTree is a GUI app to simplify your interactions with Git and Mercurial repositories. You do not need to write commands in the terminal. A free Mercurial and Git Client for Windows and Mac platforms. It provides a graphical interface for repositories, between users and Git, in which simplifies its use for beginners, who haven’t mastered Git, and experts, who can be more productive focusing solely on the code.
- MacOS: Install SourceTree v2.1. Latest version have login issues.
- Windows: Install SourceTree latest version
-
WebStorm: It is the best Javascript IDE but you'll need a license to use this app. Please contact Pooja Gulrajani (pooja@91springboard.com) for license requirements. In case a license is not available, you may install Sublime Text editor which is described next.
-
Sublime Text: Sublime Text is a sophisticated text editor. It is free to use.
Add description here...
Add description here...