Installing SilverSurfer 2

Step 1: Install Node, NPM

Install Node and NPM on your machine; this typically requires administrative access, e.g. become root or use sudo (or use a Windows installer).

You must be running at least Node 4.x.x and npm 3.x.x. You can verify what, if any, versions you have installed by running $ node -v and $ npm -v in a terminal window.

You can download current versions of these tools here.

If you use a Linux-like environment, you are encouraged to use your package manager to install these tools.

If you use OS X, you may wish to consider installing via HomeBrew.

Step 2: Install @angular/cli and angular-cli-ghpages packages globally on your system

IMPORTANT NOTE: This, and all following steps, should be run as a regular (non-root) user. Strange problems occur with package installation when you are the root user, or from using the sudo command.

In a command shell, run the following command to acquire both the "angular cli" and the "github pages" packages:

$ npm install -g @angular/cli angular-cli-ghpages

find more documentation about these packages at:

https://www.npmjs.com/package/@angular/cli, https://www.npmjs.com/package/angular-cli-ghpages

Step 3: Check out the source code

In a command shell, make a clone of the git repository:

$ git clone git@git.pehr.in:pulse/silversurfer2.git

Then enter the directory created. All further commands will be run inside that directory.

$ cd silversurfer2

Step 4: Install the NPM dependencies

$ npm install

Step 5: Run the development server

$ ng serve

(This will compile and run the node-based development server, and should automatically open your preferred browser to http://localhost:4200/. When application files are changed, the server will automatically reload the app in your browser to reflect the changes. Configuration changes require a restart.

Note: This will provide local access only (e.g. as per URL above). To allow remote access to the host, provide a --host option:

$ ng serve --host 0.0.0.0

Testing

The QuickStart documentation doesn't discuss testing. This repo adds both karma/jasmine unit test and protractor end-to-end testing support.

These tools are configured for specific conventions described below.

It is unwise and rarely possible to run the application, the unit tests, and the e2e tests at the same time. We recommend that you shut down one before starting another.

Step 6: Run Unit Tests

TypeScript unit-tests are usually in the src/app folder. Their filenames must end in .spec.ts.

Look for the example src/app/app.component.spec.ts. Add more .spec.ts files as you wish; we configured karma to find them.

Run it with $ ng test

That command first compiles the application, then simultaneously re-compiles and runs the karma test-runner. Both the compiler and the karma watch for (different) file changes.

Shut it down manually with Ctrl-C.

Test-runner output appears in the terminal window. We can update our app and our tests in real-time, keeping a weather eye on the console for broken tests. Karma is occasionally confused and it is often necessary to shut down its browser or even shut the command down (Ctrl-C) and restart it. No worries; it's pretty quick.

you can also generate a test coverage report by running $ ng test --code-coverage. that will create a folder called "coverage". inside this folder, if you double-click the index.html file to open it up in your browser, you will see a test coverage report reflecting the application's unit test coverage.

Step 7: Run End-to-end (E2E) Tests

E2E tests are in the e2e directory, side by side with the src folder. Their filenames must end in .e2e-spec.ts.

Look for the example e2e/app.e2e-spec.ts. Add more .e2e-spec.js files as you wish (although one usually suffices for small projects); we configured Protractor to find them.

Thereafter, run them with $ npm run e2e.

That command first compiles, then simultaneously starts the lite-server at localhost:8080 and launches Protractor.

The pass/fail test results appear at the bottom of the terminal window. A custom reporter (see protractor.config.js) generates a ./_test-output/protractor-results.txt file which is easier to read; this file is excluded from source control.

Shut it down manually with Ctrl-C.

Step 8: Run lint

$ ng lint

This runs the code linter TSLint, then if it exists with code 0 runs the Karma testrunner application in the browser according to config/karma.conf.js (Chrome at time of writing).

Code that does not pass TSLint will not be unit testing. Code can be linted independently by running $ npm run tslint, $ npm run lint or just $ ng lint to identify and resolve code quality issues.

Step 9: Deploy to GitHub Pages

first, you must create a build of the project using the $ ng build command but you must include the --base-href flag or it will not work, the application will not run correctly. so include the --base-href flag and then the url of the corresponding github repo and make sure to include the / character at the end of the url or it will not work so it should be something like this $ ng build --base-href https://pulse.github.io/silversurfer2/. then, all you have to do is run the command $ ngh and the application will be deployed to GitHub Pages. make sure that "github pages" is active on your github account. find more documentation about the "github pages" package at:

https://www.npmjs.com/package/angular-cli-

Notes

this application will function better in conjonction with a backend of some sort, whether it is an actual backend or just a mock one. to get up and running with "SilverSurfer 2" right away, clone the "node-backend" repository at this url: https://git.pehr.in/pulse/node-backend, download the dependencies and start the node-backend server following these easy instructions:

1. $ npm install -g nodemon

2. $ cd ..

3. $ git clone git@git.pehr.in:pulse/node-backend.git backend

4. $ cd backend

5. $ npm install

6. $ nodemon server