https://github.com/orafaelfragoso/angular-es6-boilerplate
A simple boilerplate for Angular 1.X Components and Directives with ES6 + Karma + Webpack 2
https://github.com/orafaelfragoso/angular-es6-boilerplate
angular-components angular-directives angular1 boilerplate ecmascript2015 es6 karma webpack2
Last synced: 8 months ago
JSON representation
A simple boilerplate for Angular 1.X Components and Directives with ES6 + Karma + Webpack 2
- Host: GitHub
- URL: https://github.com/orafaelfragoso/angular-es6-boilerplate
- Owner: orafaelfragoso
- License: mit
- Created: 2017-04-25T14:15:57.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-09T15:46:58.000Z (about 9 years ago)
- Last Synced: 2025-02-01T01:25:23.778Z (over 1 year ago)
- Topics: angular-components, angular-directives, angular1, boilerplate, ecmascript2015, es6, karma, webpack2
- Language: JavaScript
- Homepage:
- Size: 56.6 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Angular ES6 Component Boilerplate [](https://travis-ci.org/rafaelfragosom/angular-es6-boilerplate)
A simple boilerplate for Angular 1.X Directives and Components with ES6 + Karma + Webpack2
## Table of Contents
1. [Why?](#why)
2. [Getting Started](#getting-started)
1. [Prerequisites](#prerequisites)
2. [Installing](#installing)
3. [Using](#using)
4. [New to Using ES6 with AngularJS 1.X?](#new-to-using-es6-with-angularjs-1x)
6. [Built With](#built-with)
6. [Contributing](#contributing)
7. [Versioning](#versioning)
8. [Authors](#authors)
9. [To do](#to-do)
10. [License](#license)
## Why?
Angular 1.X is still a thing and it's used in a lot of projects across the planet. The goal of this project is to make developers one step closer to the Angular2 synthax, using the ES6 goodies, when it comes to generating new components and directives for open source.
Check out [Angular Image Preloader](https://github.com/rafaelfragosom/angular-image-preloader)
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See usage for notes on how to use the project on a live project.
### Prerequisites
- ^NodeJS 4.X
- ^AngularJS 1.2.X (^1.5.X if you want to use Component())
### Installing
**Step 1**: Cloning the repo
```bash
$ git clone https://github.com/rafaelfragosom/angular-es6-boilerplate your-project-name
$ cd your-project-name/
```
**Step 2**: Install the dependencies
```bash
$ npm install
```
Or using Yarn
```bash
$ yarn install
```
**Step 3**: Edit these files to build your project correctly
```
package.json
src/
/index.js
/demo.js
/demo.spec.js
```
### Using
**Running your project:**
```
npm start
```
### New to Using ES6 With AngularJS 1.X?
[Check this out](https://thinkster.io/angularjs-es6-tutorial)
## Built With
* [Angular 1.X](https://angularjs.org/) - The web framework this was built for
* [Webpack 2](https://webpack.js.org/) - Package Bundler
* [Babel](https://babeljs.io/) - ES6 to ES5
* [ESLint](http://eslint.org/) - JavaScript Code Linter
## Contributing
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/rafaelfragosom/angular-es6-boilerplate/tags).
## Authors
* **Rafael Fragoso** - *Initial work* - [rafaelfragosom](https://github.com/rafaelfragosom)
See also the list of [contributors](https://github.com/rafaelfragosom/angular-es6-boilerplate/contributors) who participated in this project.
## TODO
- [ ] Yeoman Generator
- [ ] Demo Page
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details