Skip to content

Latest commit

 

History

History
103 lines (84 loc) · 3.41 KB

README.md

File metadata and controls

103 lines (84 loc) · 3.41 KB
Raw

angular-seed-es6

Build Status devDependency Status

This project is an application skeleton for a typical AngularJS 1.x web app using the best practices and with ES6. You can use it to quickly bootstrap your angular webapp projects and dev environment for these projects.

The seed contains a sample AngularJS application and is preconfigured to install the Angular framework and a bunch of development tools for instant web development gratification.

The seed app doesn't do much, just shows how to wire two controllers and views together.

Features

Please see the gulpfile for up to date information on what it supports.

  • ES6 out of the box
  • Browserify
  • Built-in hot-reload preview server with BrowserSync
  • Compile Sass with libsass
  • Map compiled JS/CSS to source with source maps
  • HTML and CSS minification
  • Cache-busting to all JS and CSS files

Getting Started

  • Install dependencies: npm install
  • Run npm start to preview and watch for changes with hot reload
  • Run npm run build to generate a distributable, production-ready, build directory

Now browse to the app at http://localhost:8000.

Directory Layout for development

app/                    --> all compiled files for the application
  assets/               --> static files
    favicon.ico
  js/                   --> js files
    view-one/
      controllers/
        controllers.js    --> controller logic
      services/
        count-store.js    --> service logic
      directives/
        title-example.js  --> directive logic
      modules.js          --> define the module dependencies
    view-two/
      controllers/
        controllers.js    --> controller logic
      modules.js          --> define the module dependencies
    modules.js            --> main application module, load all states for the page.
  scss/                   --> sass files
    section/
      view-one/
        _index.scss
      view-two/
        _index.scss
        count-store.js
    variables/
      _colors.scss
      _index.scss
    main.scss           --> main sass
  templates/            --> html files
    view-one/
      view-one.html
    view-two/
      view-two.html
  index.html            --> the main html template file of the app

Directory Layout for production

build/                  --> all compiled files for the application
  assets/               --> static files
    favicon.ico
  css/                  --> css files
    main.min.css        --> compiled scss
    main.min.css.map    --> source map for scss
    libs.min.css        --> compiled third-party styles
    libs.min.css.map    --> source map for third-party styles
  js/                   --> js files
    app.js              --> minify angular files
    libs.js             --> minify third-party librarys
  templates/            --> html files
    view-one/
      view-one.html     --> minify html
    view-two/
      view-two.html     --> minify html
  index.html            --> the main html template file of the app

Testing

  • TODO

Inspired by