https://github.com/hckhanh/angular-stater-kit
https://github.com/hckhanh/angular-stater-kit
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hckhanh/angular-stater-kit
- Owner: hckhanh
- License: mit
- Created: 2016-09-09T11:50:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-09-11T07:36:17.000Z (over 8 years ago)
- Last Synced: 2025-01-13T06:44:58.649Z (4 months ago)
- Language: JavaScript
- Size: 29.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# angular-starter-kit
A complete, yet simple, starter for Angular using Webpack.
This workflow serves as a starting point for building Angular 1.x applications using Webpack. Should be noted that apart from the pre-installed angular package, this workflow is pretty much generic.
* Heavily commented webpack configuration with reasonable defaults.
* ES6, and ES7 support with babel.
* Source maps included in all builds.
* Development server with live reload.
* Production builds with cache busting.
* Testing environment using karma to run tests and jasmine as the framework.
* Code coverage when tests are run.
* No gulp and no grunt, just npm scripts.
>Warning: Make sure you're using the latest version of Node.js and NPM
## Quick start
> Clone/Download the repo then edit `app.js` inside [`/src/app/app.js`](/src/app/app.js)
```bash
# clone our repo
$ git clone https://github.com/hckhanh/angular-stater-kit your-project-name
# change directory to your app
$ cd your-project-name
# install the dependencies with npm
$ npm install
# start the server
$ npm start
```
go to [http://localhost:3000](http://localhost:3000) in your browser.
## Table of Contents
* [Getting Started](#getting-started)
* [Dependencies](#dependencies)
* [Installing](#installing)
* [Running the app](#running-the-app)
* [Developing](#developing)
* [Testing](#testing)
* [License](#license)
## Getting Started
### Dependencies
What you need to run this app:
* `node` and `npm`
* Ensure you're running the lastest version of Node and NPM
### Installing
* `fork` this repo
* `clone` your fork
* `npm install` to install all dependencies
### Running the app
After you have installed all dependencies you can now run the app with:
```bash
npm start
```
It will start a local server using `webpack-dev-server` which will watch, build (in-memory), and reload for you. The port will be displayed to you as `http://localhost:3000`.
### Developing
#### Build files
* single run: `npm run build`
* build files and watch: `npm run watch`
### Testing
#### 1. Unit Tests
* single run: `npm test`
* live mode (TDD style): `npm run test-watch`
## License
[MIT](/LICENSE)