Code Monkey home page Code Monkey logo

angular-espresso's Introduction

Angular Espresso

Start an app with AngularJS on the client, Express + Node + Socket.IO as your back-end, all written in CoffeeScript.

Current version

Current version: 0.3.0

This version includes the following components:

  • AngularJS 1.2.20
  • Twitter Bootstrap 3.2.0
  • Express 4.6.1
  • LESS 1.7.3
  • Socket.IO 1.0.6
  • Jade 1.4.2
  • UglifyJS 2.4.15
  • Body Parser 1.4.3
  • Serve Favicon 2.0.1

Installation

You need to have installed node, CoffeeScript, make sure you install CoffeeScript globally. You also need LESS.

Once you have them installed, extract the downloaded file, go to the directory it was extracted to and execute setup.sh or setup.bat (depending on your OS):

Cakefile Usage

Once you install the dependencies, use the Cakefile for performing different actions:

cake build                # Builds app
cake build:module         # Builds the Espresso module
cake build:client         # Builds client scripts
cake clean                # Clean module and client
cake clean:module         # Cleans the Espresso module
cake clean:client         # Cleans the client
cake run                  # Runs the app (you should build first)

The typical usage would be:

cake build
node app # or cake run

Configuration

There's no configuration for using Angular Espresso, all you need to do is download the project, install its dependencies with npm and run your node app.

Your .coffee files should be under the "app" folder. The project structure is the following:

NOTE: Each directory has a README file with more detail

  • Angular: Your AngularJS app should go in this directory
  • Services: Backend logic goes here
  • Config: Configuration that may be used to set up different values for a specific environment or a common config
  • Routes: This directory should contain the routing functions for your views. Define an entry point for a major component of your site and then use partials for all its sub-components
  • Resources: Any client scripts not related to AngularJS

At the root folder, there are two more folders to consider:

  • Styles: Your LESS styles should go in this directory. Keep in mind that the project has Twitter Bootstrap already included
  • Views: Your views/partial views should go here

In the future, I will be adding support for testing. I won't implement file watching until it is stable in node.

Contribute

If you want to help, fork/clone/share the project, suggest new features, and/or submit pull requests. Contact me directly at [email protected] or @_williammora.

Author

William Mora - @_williammora - http://www.williammora.com

References

For more on AngularJS: http://angularjs.org

For more on CoffeeScript: http://coffeescript.org

For more on Express: http://expressjs.com

For more on Jade: http://jade-lang.com

For more on Socket.IO: http://socket.io/

For more on LESS: http://lesscss.org/

angular-espresso's People

Contributors

wmora 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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

angular-espresso's Issues

README Update for version 0.2.0

README should be updated with the following changes:

  • Sync with gh-pages
  • Include less installation in instructions
  • Mention less support

Use of LESS

The project should use LESS as its stylesheet language. Cakefile should include its compilation and/or minification when executing build:client

Setup scripts

Directories should be created at project setup, not by cakefile

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.