angular-seed

Angular RequireJS Boilerplate

Added by: Sam Deering

GitHub

Repository

mohislm/angular-seed

Stats

Stars: 71

Watchers: 71

Forks: 36

Module Description

Angular + RequireJS Boilerplate

This project is an application skeleton for an ideal AngularJS web app. You can use it with a minimal configuration to easily bootstrap your angular projects.

The seed contains the AngularJS and RequireJS libraries, and a clean directory structure for your app. Just clone the repo (or download the zip/tarball), start up a web server and you are ready to develop with a minimum effort.

The sample app in this seed doesn't do much, just shows how to hook up couple of controllers and views together. You can check it out by opening index.html in your browser (using a local web server of course!)

Directory Structure

The directory structure is flexible. It doesn't have to be in the following structure. You can always change it from config.js.

root
|
├── js
|   |
|   ├── app
|   |   |
|   |   ├── controllers
|   |   ├── directives
|   |   ├── filters
|   |   ├── services
|   |   ├── views
|   |   |
|   |   ├── config.js
|   |   └── main.js
|   |
|   └── lib
|       |
|       ├── angular.js
|       ├── ng-app.js
|       └── require.js
|
└── index.html

Configuration

  • Step 1 - For each application, copy the app directory and place it where you like.
  • Step 2 - Rename the directory.
  • Step 3 - Open up config.js, and modify it to match your app configuration:
define({
    appName: 'YourAppName',
    appDir: '/js/app',
    libDir: '/js/lib',
    routes: {
        '/path' : 'subdir/Controller1',
        '/path/with/:id' : 'subdir/Controller2',
        '/more/path' : 'Controller3'
    },
    defaultRedirect: '/path'
});

Notice that, the controllers and views can be organized by placing them under sub-directories. But it still works, if you wish to place them directly under the controllers and views directories.

Seed Project : PhoneBook App

The PhoneBook example project included in this seed has two controllers (Contact and ContactDetail) and one service (contactService). The purpose is simply retrieving data from a model and populate the view accordingly.

Inspired by

Module stats last updated: 2017-10-05 16:00:01

Disclaimer: Some data on this page may have been gathered from the authors GitHub respository. If you see any mistakes or outdated information please let us know. Thanks!