Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antonybudianto/angular-hackathon-starter
:bulb: Hackathon ready starter with Angular and Firebase (Updated to latest Angular 4 and angularfire@next)
https://github.com/antonybudianto/angular-hackathon-starter
angular firebase hackathon starter
Last synced: about 2 months ago
JSON representation
:bulb: Hackathon ready starter with Angular and Firebase (Updated to latest Angular 4 and angularfire@next)
- Host: GitHub
- URL: https://github.com/antonybudianto/angular-hackathon-starter
- Owner: antonybudianto
- License: mit
- Created: 2016-11-27T02:47:27.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-20T14:42:25.000Z (over 7 years ago)
- Last Synced: 2024-04-11T21:10:57.904Z (5 months ago)
- Topics: angular, firebase, hackathon, starter
- Language: TypeScript
- Homepage:
- Size: 3.04 MB
- Stars: 5
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Angular Hackathon Starter
[](https://travis-ci.org/antonybudianto/angular-hackathon-starter)
[](https://coveralls.io/github/antonybudianto/angular-hackathon-starter?branch=master)
[](https://david-dm.org/antonybudianto/angular-hackathon-starter)
[](https://david-dm.org/antonybudianto/angular-hackathon-starter#info=devDependencies)
[](https://dependencyci.com/github/antonybudianto/angular-hackathon-starter)
> Live Production Build [Demo](http://angular-hackathon-starter.surge.sh/) - Coming soon!
## Introduction
Welcome to Angular Hackathon Starter!
This starter is specially made for hackathon enthusiasts
> This repo is evolved from [Angular Webpack Starter](https://github.com/antonybudianto/angular-webpack-starter)
### What's included?
* [Angular](https://angular.io)
* [Firebase](https://firebase.google.com)
Please visit the main [wiki](https://github.com/antonybudianto/angular-webpack-starter/wiki) for more details.
## Prerequisites
You need to have [Node.js and npm](https://nodejs.org/en/)
- Support Node v4 - latest
- Support npm v3 - latest
- Support [Yarn](https://yarnpkg.com/)
## Installation
Download the starter from [releases page](https://github.com/antonybudianto/angular-hackathon-starter/releases)
Go to the starter directory and install the packages ([Yarn](https://github.com/yarnpkg/yarn) is recommended):
```bash
npm install
```
Then copy `.env.example` and rename it as `.env`. For more [details](https://github.com/antonybudianto/angular-webpack-starter/wiki/Environment-Variables)
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:
```bash
// 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
```bash
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:
```bash
npm start
```
To begin testing, run:
```bash
npm run e2e
```
## Production
> For more details, visit [Continuous Integration wiki](https://github.com/antonybudianto/angular-webpack-starter/wiki/Continuous-Integration)
You can create production build by running:
```bash
npm run build
```
or you can create production build and then serve it using Lite Server by running:
```bash
npm run serve:build
```
## Contributing
Feel free to submit a PR if there are any issues or new features, please read [this](https://github.com/antonybudianto/angular-hackathon-starter/wiki/Contributing) before
## License
MIT