README.md

Angular Hackathon Starter

Live Production Build Demo - Coming soon!

Introduction

Welcome to Angular Hackathon Starter! This starter is specially made for hackathon enthusiasts

This repo is evolved from Angular Webpack Starter

What's included?

• Angular
• Firebase

Please visit the main wiki for more details.

Prerequisites

You need to have Node.js and npm

• Support Node v4 - latest
• Support npm v3 - latest
• Support Yarn

Installation

Download the starter from releases page

Go to the starter directory and install the packages (Yarn is recommended):

npm install

Then copy .env.example and rename it as .env. For more details

After that, get your Firebase app config from Firebase console, and export them at src/app/core/firebase/config.ts

Start

Let's start up, run following:

// Build DLL first, run this once after adding new package
npm run build:dll

// Start the app
npm start

and done! Open a browser and go to http://localhost:8080 and you can start developing Angular! Every changes to the file will refresh the browser automatically and it'll also compile your changed TypeScripts files to Javascript files.

If any error occured when starting, please retry npm run build:dll. That means DLL build is too old and need to be refreshed.

Testing

This starter comes with testing workflow

Unit testing

Just run

npm test

and it'll compile all TypeScript files, start Karma, then remap Istanbul coverage so that it shows TypeScript coverage, not the transpiled JavaScript coverage.

E2E testing

Firstly start the server:

npm start

To begin testing, run:

npm run e2e

Production

For more details, visit Continuous Integration wiki

You can create production build by running:

npm run build

or you can create production build and then serve it using Lite Server by running:

npm run serve:build

Contributing

Feel free to submit a PR if there are any issues or new features, please read this before

License

MIT