https://github.com/btford/angular-socket-io-seed

A great starting point for writing AngularJS apps backed by a Socket.io-powered node.js server.
https://github.com/btford/angular-socket-io-seed

Last synced: 10 days ago
JSON representation

A great starting point for writing AngularJS apps backed by a Socket.io-powered node.js server.

• Host: GitHub
• URL: https://github.com/btford/angular-socket-io-seed
• Owner: btford
• Created: 2012-06-27T23:37:18.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2019-02-02T17:17:29.000Z (almost 6 years ago)
• Last Synced: 2024-10-29T16:41:19.073Z (13 days ago)
• Language: JavaScript
• Size: 4.22 MB
• Stars: 765
• Watchers: 52
• Forks: 186
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Angular Socket.io Seed

Start an awesome app with AngularJS on the front, Socket.io + Express + Node on the back. This

project is an application skeleton for writing [AngularJS](http://angularjs.org/) apps that use

web sockets to add real-time functionality. If you're not planning on using web sockets, you

should consider the [Angular Express Seed](https://github.com/btford/angular-express-seed) instead.

The seed contains angular libraries, test libraries and a bunch of scripts all preconfigured for

instant web development gratification. Just clone the repo (or download the zip/tarball) and

you're ready to develop your application.

The seed app shows how to wire together Angular client-side components with Socket.io and Express

on the server. It also illustrates writing angular partials/views with the Jade templating library.

_Note: Although Jade supports interpolation, you should be doing that mostly on the client. Mixing

server and browser templating will convolute your app. Instead, use Jade as a syntactic sugar for

HTML, and let AngularJS take care of interpolation on the browser side._

## How to use it

Clone the angular-socket-io-seed repository and start hacking!

### Running the app

Runs like a typical express app:

```shell

node app.js

```

### Running tests

Coming soon!

### Receiving updates from upstream

Just fetch the changes and merge them into your project with git.

### Updating `angular.js`

Alternatively, you can update AngularJS with [Bower](http://bower.io):

```shell

bower update angular

```

## Example Application

I created a [simple instant messaging application](https://github.com/btford/angular-socket-io-im)

and wrote a [blog post](http://briantford.com/blog/angular-socket-io.html) walking through the app to

illustrate using the seed.

## Directory Layout

    

    app.js                  --> app config

    bower.json              --> for bower

    package.json            --> for npm

    public/                 --> all of the files to be used in on the client side

      css/                  --> css files

        app.css             --> default stylesheet

      img/                  --> image files

      js/                   --> javascript files

        app.js              --> declare top-level app module

        controllers.js      --> application controllers

        directives.js       --> custom angular directives

        filters.js          --> custom angular filters

        services.js         --> custom angular services

      bower_components/

        angular/            --> angular.js

        angular-socket-io/  --> socket.io adapter for angular

    routes/

      index.js              --> route for serving HTML pages and partials

    views/

      index.jade            --> main page for app

      layout.jade           --> doctype, title, head boilerplate

      partials/             --> angular view partials (partial jade templates)

        partial1.jade

        partial2.jade

## Contact

For more information on AngularJS please check out http://angularjs.org/

For more on Express and Jade, http://expressjs.com/ and http://jade-lang.com/ are

your friends.