https://github.com/navarroaxel/nodejs-template

A node.js template app
https://github.com/navarroaxel/nodejs-template

Last synced: about 1 month ago
JSON representation

A node.js template app

• Host: GitHub
• URL: https://github.com/navarroaxel/nodejs-template
• Owner: navarroaxel
• License: mit
• Created: 2014-05-03T20:13:30.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-05-21T12:29:13.000Z (over 9 years ago)
• Last Synced: 2024-04-09T11:27:45.544Z (7 months ago)
• Language: JavaScript
• Size: 203 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nodejs-template

A node.js template app using Express, AngularJS and Mongoose. The client side libraries are managed by Bower and the view engine is justhtmlm the render is processed in the client side powered by AngularJS.

## setting dev environment

After clone this project you should install the npm packages and bower packages.

    npm install -g bower

    npm install

    bower install

To run the app you should use this command.

    npm start

# Architecture

## toolkit

Presents common functions independent of the business: validations, security, logging, etc.

## model

Defines the entities of the application, these are objects not defined by its attributes, but rather by a thread of continuity and its identity.

The business logic should be placed in this module. The approach to develop a complex application using here is Domain drive-design http://en.wikipedia.org/wiki/Domain-driven_design

## services

When an operation does not conceptually belong to any object. Following the natural contours of the problem, you can implement these operations in services.

## routes

Handles the HTTP requests. The business logic should not be placed here because this routers are attached to the HTTP protocol, it's hard to test and cannot be reused easily.

The public-api folder is public and does not need a user's session.

The api folder is a private API and need a valid user's session to use.

## public

This is all the client side content, the user can access this content freely.

The front-end is an AngularJS app using the SPA approach.

The controls folder is a collection of Angular's directives that representes a business object, i.e. the html tag  is replaced with the readonly customer profile to be displayed everywhere in the app.

## config

The config.json file is located in the root folder.

## resources

All the html to build PDFs or e-mails, or another type of media resources for server side process.

# Updating front-end packages

    bower update 

more info about Bower in http://bower.io/

# Changing connection string to database.

You should looking for the connectionString field in the /config.json file. An example of a connection string is: (mongodb://\:\@\:\/\?safe=true)