JavaScript TypeScript HTML CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
.dockerignore
.editorconfig
.gitignore
CHANGELOG.md
Dockerfile
LICENSE
README.md
e2e-spec.js
index.html
karma-test-shim.js
karma.conf.js
package.json
protractor.config.js
styles.css
tsconfig.json
tslint.json
typings.json
wallaby.js

README.md

ProgrammersGuideToTheGalaxy Site

This repository is the site that uses the ProgrammersGuideToTheGalaxy code: https://github.com/stuartaroth/programmersguidetothegalaxy

It was created using the Angular 2 quickstart code: https://github.com/angular/quickstart

Install the npm packages described in the package.json and verify that it works:

Attention Windows Developers: You must run all of these commands in administrator mode

npm install
npm start

The npm start command first compiles the application, then simultaneously re-compiles and runs the lite-server. Both the compiler and the server watch for file changes.

Shut it down manually with Ctrl-C.

You're ready to write your application.

npm scripts

We've captured many of the most useful commands in npm scripts defined in the package.json:

  • npm start - runs the compiler and a server at the same time, both in "watch mode".
  • npm run tsc - runs the TypeScript compiler once.
  • npm run tsc:w - runs the TypeScript compiler in watch mode; the process keeps running, awaiting changes to TypeScript files and re-compiling when it sees them.
  • npm run lite - runs the lite-server, a light-weight, static file server, written and maintained by John Papa and Christopher Martin with excellent support for Angular apps that use routing.
  • npm run typings - runs the typings tool.
  • npm run postinstall - called by npm automatically after it successfully completes package installation. This script installs the TypeScript definition files this app requires.

Here are the test related scripts:

  • npm test - compiles, runs and watches the karma unit tests
  • npm webdriver:update - ONE TIME update for protractor end-to-end (e2e) tests
  • npm run e2e - run protractor e2e tests, written in JavaScript (*e2e-spec.js)

Contributing

Pull requests are very welcome! When it comes to UI and CSS things I'm far too utilitarian and would love for the site to work/look/feel much better.

Testing

Yeah this needs to be done. Sometime.