Code Monkey home page Code Monkey logo

angular-starter-kit's Introduction

Angular Starter Kit

This is an opinionated starter template for crafting single-page web applications using Angular.js, Coffeescript, SCSS, Jade, Bootstrap, UI-Router, Font-Awesome and a few other carefully picked tools that help kick-start web app development. To compile your app, it uses Gulp.js and a number of pre-processors, plugins, and utilities.

Getting Started

  1. I highly recommend that you read through gulpfile.coffee. It's relatively simple and will help you understand how the assets are being compiled in case you run into any issues.
  2. Install dependencies: NPM, Ruby, Bundler, PhantomJS
  3. Clone the repository
  4. Run bundle install. This will install the version of SASS specified in the Gemfile.
  5. Run npm install
  6. Run bower install
  7. Run gulp in one shell. This will watch your files, auto-compile them, and start a local server.
  8. Run npm run test in another shell. This will automatically run your unit tests.
  9. Install LiveReload (optional)
  10. Open your browser to http://localhost:9000.
  11. This site is the default code and the documentation. I suggest checking out the sample code page, but then you just need to remove what you don't want and replace this content with your own. Have fun!

Deploying for Production

If you run gulp deploy, it will compile all the assets and also minify them and then place them into the deploy directory.

Running E2E Tests

  1. npm install -g protractor - Install Protractor globally
  2. webdriver-manager update - Installs the Selenium web driver required to run protractor tests. It may ask you to install the Java Development Kit, which is required.
  3. npm run e2e - This will run the e2e tests. Because these tests are fairly slow, they are not setup to auto-run on file changes.

Demo

You can see what the initial template looks like here: Demo

To-Do

  1. Task to compile for production that minifies all the code and places in a "deploy" directory
  2. Use cache-busting filenames for production mode

angular-starter-kit's People

Contributors

adamalbrecht avatar mez avatar ryanlewis avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.