Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

chore(README): development setup - add deploy-install step #2915

Merged
merged 1 commit into from
Nov 30, 2016
Merged

chore(README): development setup - add deploy-install step #2915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,24 @@ This site relies heavily on node and npm.
1. Make sure you are using at least node v.5+ and latest npm;
if not install [nvm](https://github.com/creationix/nvm) to get node going on your machine.

1. Install npm `gulp` package *globally*: `npm install -g gulp`
1. Install global npm packages by running `./scripts/before-install.sh`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you revert this line? Not all windows users use a console that can run bash scripts.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, but wouldn't that apply to all scripts mentioned in the dev setup?

I'm just trying to keep this all DRY. We know that the scripts are kept up-to-date because they are run on Travis. If we duplicate the script commands here, then they run the risk of becoming out of step ... as they did this morning.

If a Windows user can't run a script I'd assume that they'd look inside and run the equivalent commands under Windows. Would that do?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's only one other mention of the scripts in the readme (the one for resetting the environment).

I guess it's fine, but will keep an eye out to see if new authors or users have having trouble.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sgtm, ty


1. Clone this repo, the [angular/angular source code repo](https://github.com/angular/angular), and the [dart-lang/angular2 source code repo](https://github.com/dart-lang/angular2) to the same parent directory.
The three cloned repo directories must be siblings, with the latter two repo directories named **angular** and **angular-dart**, respectively.
1. Clone

- this repo
- [angular/angular source code repo](https://github.com/angular/angular)
- (OPTIONAL) [dart-lang/angular2 source code repo](https://github.com/dart-lang/angular2);
cloning the Angular Dart repo is only necessary if you plan on doing full site builds

to the same parent directory. The **cloned repo directories must be siblings**, with the latter two repo directories named **angular** and **angular-dart**, respectively.

1. cd into root directory `angular.io/`

1. install the *all-docs* local packages by running `npm install`
> You probably must rebuild `node-sass` in a separate step: `npm rebuild node-sass`
1. Install local npm packages by running `./scripts/install.sh`

1. (OPTIONAL) If you intend on doing **full site builds** then you must have the
Angular Dart repo (see the Clone step above), _and_ Dart tooling available.
Both can be installed by running `./scripts/deploy-install.sh`

1. See [below](#code-sample-development) for code sample development preparation.

Expand Down
4 changes: 1 addition & 3 deletions scripts/before-install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,5 @@ set -e -o pipefail
[[ -n "$TRAVIS" ]] && . ./scripts/env-info-and-check.sh

if [ -z "$TRAVIS" ]; then
set -x
npm install -g gulp --no-optional
set +x
(set -x; npm install -g gulp --no-optional)
fi