Switch branches/tags
Nothing to show
Clone or download

README.md

Angular Lab

Build Status Dependency Status Gitter

Playground for experimenting with some of the core features of Angular and integration with other software and services.

This setup is using:

PaaS:

  • Firebase - realtime store for the app's data, authentication and hosting provider

Unit/E2E tests & format check:

CI/CD:

Tools:

Package management:

  • David - keeps an eye on all the project dependencies versions
  • NPM
  • Yarn

Table of Contents

Setup


Make sure you have Node version v7.9 (or above) installed.

If you'd like to use Yarn, follow their instructions to install it on your platform, otherwise make sure at least NPM 5 is installed, you can check the version with npm --version.

Follow the instructions for setting up the app:

  1. Clone the repository: git clone https://github.com/rolandjitsu/angular-lab.git;
  2. From the root of the project, install dependencies: yarn install/npm install;

NOTE: Keep in mind that every package that was installed has to be invoked with either $(npm bin)/<package> or node_modules/.bin/<package>. Or if you want to avoid writing all of that every time:

  1. Install direnv;
  2. Setup .envrc (just a file) with export PATH=$PATH:$PWD/node_modules/.bin;
  3. Run direnv allow at the root of the project where .envrc resides.

Now you can simply run <package>.

Environment

If you'd like to use env variables, such as API keys, in the app, you can do so by importing from secrets:

import {MY_SECRET} from 'secrets';

For the above to work, you need to:

  1. Add MY_SECRET to the .secrets file (MY_SECRET needs to be an env variable)
  2. Add the var to src/typings.d.ts:
declare module "secrets" {
    ...
    export const MY_SECRET: any;
}
  1. Run npm run secrets:eject

The last command will generate a .secrets.js module file containing all the secrets. This file is aliased to the secrets path you use to import from (using the TS {paths} compiler option).

NOTE: All the values will be strings, therefore, it's up to you to parse them as needed.

Firebase

Hosting

In order to use your own Firebase account for hosting the app, follow the instructions below:

  1. Run $(npm bin)/firebase login:ci to get an auth token (follow the steps you are given by the command) and export it export FIREBASE_TOKEN=<your Firebase token>;
  2. Get the Firebase API key (use $(npm bin)/firebase setup:web to get it from {apiKey}) and export it export FIREBASE_API_KEY=<your Firebase API key>;
  3. Replace angular-laboratory with your own Firebase project id in .firebaserc.

Given that you have FIREBASE_TOKEN and FIREBASE_API_KEY exported as env var, you can deploy the app to your own Firebase account with:

# NOTE: This also generates a .secrets.js
npm run deploy

Or you can also use the following to set FIREBASE_TOKEN/FIREBASE_API_KEY and deploy:

FIREBASE_API_KEY=<your Firebase API key> FIREBASE_TOKEN=<your Firebase token> npm run deploy

Travis CI

If you plan on using this setup with your own projects and you wish to setup Travis CI, you must make sure of a few of things in order to have everything working properly on the CI:

  1. For deployments, setup the env variable FIREBASE_TOKEN containing the token you got from $(npm bin)/firebase login:ci:
    • Encrypt the token using travis encrypt FIREBASE_TOKEN=<your Firebase token>, see docs to find out more about it;
    • Replace the secure key's value with the string generated from the previous step (it's right below FIREBASE_TOKEN in .travis.yml);
  2. For connecting the app to Firebase (and properly building the app), setup the FIREBASE_API_KEY env variable:
    • Encrypt the API key using travis encrypt FIREBASE_API_KEY=<your Firebase API key>;
    • Replace the secure key's value with the string generated from the previous step (it's right below FIREBASE_API_KEY in .travis.yml);
  3. For tests that run on Saucelabs, setup the env variables SAUCE_USERNAME and SAUCE_ACCESS_KEY:
    • Replace SAUCE_USERNAME with your own username (no need to encrypt);
    • Encrypt the access key using travis encrypt SAUCE_ACCESS_KEY=<your Saucelabs access key>;
    • Replace the secure key's value with the string generated from the previous step (it's right below SAUCE_ACCESS_KEY in .travis.yml);
  4. Remove the webhooks section from notifications in .travis.yml.

If you don't want to deploy to Firebase on push skip the 1st and 2nd step in the instructions above and remove the following in .travis.yml:

  • after_success: npm run deploy:ci step;
  • Encrypted FIREBASE_TOKEN env var;
  • Encrypted FIREBASE_API_KEY env var.

If you don't use Saucelabs, skip the 3nd step and remove the following in .travis.yml;

  • sauce_connect section from addons;
  • Encrypted SAUCE_USERNAME and SAUCE_ACCESS_KEY env vars.

Now, keep in mind that cloning this repo and continuing in the same project will give you some issues with Travis if you wish to set it up with your own account. So I suggest you start out with a clean project and start git from scratch (git init), then copy over things from this project (obviously, do not include .git - not visible on most UNIX base systems).

Development


All you need to get started is npm start (or npm start:prod if you need to emulate a production environment). Now you should see the app running in the browser (might take a while when compiling the first time).

Below you can find a few of things to help understand how this setup works and how to make it easier when developing on this app.

Info

Angular CLI is used to handle every aspect of the development of the app (e.g. building, testing, etc.). To get started, npm start will start a static webserver, rerun builds on file changes (styles, scripts, etc.), and reload the browser after builds are done.

Unit tests run the same way, whenever there is a change the tests will rerun on the new code. For further info about tests read below.

Run Tests

Tests can be run selectively as it follows:

  • npm run lint: runs tslint and checks all .ts files according to the tslint.json rules file;
  • npm run lint:fix: runs the above command and also tries to fix some of failures (see the rules with Has Fixer flag);
  • npm run test:continuous: unit tests in Chrome headless; runs in watch mode (i.e. watches the source files for changes and re-runs tests when files are updated);
  • npm run test: unit tests in Chrome headless; runs in single run mode, meaning it will run once and it will not watch for file changes;
  • npm run test:ci: unit tests on the CI server; same as npm run test, but it runs on Saucelabs browsers;
  • npm run e2e: e2e tests in Chrome headless without code watch or live reload;
  • npm run e2e:ci: e2e tests on the CI server, but on Saucelabs browsers.

Angular CLI

In case you need to build everything, run npm run build (use npm run build:prod if the build is for production).

To see what other commands Angular CLI has, run $(npm bin)/ng help. Or take a look at the scripts section in package.json for project specific commands.

Deployments


Deployments are handled by Travis CI. Pushing to master will automatically deploy the app, given that all tests pass.

Learning Material


Browser Support


You can expect the app to run wherever Angular does, but check the matrix below to see where the project tests pass.

Sauce Tests

Contribute


If you wish to contribute, please use the following guidelines:

  • Use Conventional Changelog when committing changes
  • Follow Angular Styleguide
  • Use npm run lint/npm run lint:fix to fix any TS warnings/errors before you check in anything:
    • It will run TSLint to check for any inconsistencies
    • It will check against Angular styleguide using codelyzer
    • If npm run lint:fix was used, it will fix some errors
  • Use [ci skip] in commit messages to skip a build (e.g. when making docs changes)

Credits


In the making of this simple app, I have made use of whatever resources I could find out there, thus, it's worth mentioning that the following projects have served as inspiration and help: