el-sonny / contratobook Goto Github PK

#Contratobook

##Objetivo

Usando un CSV de contratos de gobierno construir un API con SailsJS y un frontend con angular que lo utilize. El proyecto se llamara contratobook.

###Requisitos:

• NodeJS
• npm
• mongo
• sails
• bower

##Parte I - configuración de app y DB

###Importar DB

mongoimport -d contratobook -c contrato --type csv --headerline /ruta/al/archivo.csv

• Usar (mongoimport --help para entender que significan estos parametros):
• Ingresar a la interfaz de comandos de mongo y verificar que tenga registros nuestra collection (tabla) deben ser 101 registros;

use contratobook;
db.contrato.count();`

###Inicializar APP

En terminal navegar a carpeta de este proyecto (ej. ~/dev/contratobook/) desde ahi ejecutar:

sails new {tunombre}

Despues puedes levantar el app con sails lift, nodemon ó node app.js y navegar a http://localhost:1337 para verificar que este funcionando

###Configurar DB

Desde ahora en adelante todos los comandos son en la raiz de nuestro proyecto (~/dev/contratobook/{tunombre})

• Instalar el adapator de mongo en nuestro proyecto

npm install --save sails-mongo

• En el archivo config/connections.js
  • Cambiar someMongoServer a mongo y en ese registro
    • Configurar database a el nombre de nuestra db: contratobook
    • Configurar el user y pass en blanco ''
• En el archvio config/model.js cambiar conection a 'mongo' y migrate a 'safe'

###Crear API y Probar

Para generar al API de contratos dentro de la carpeta del proyecto ejecutar:

sails generate api contrato

Esto genera un archivo en api/models y otro en api/controllers. Con esto y nuestros datos tenemos una api funcional pero tenemos que habilitarlo:

• En el archivo config/blueprints.js configurar actions y rest a true y prefix a '/api'

Para probar ejecutamos:

sails lift

Posteriormente en el navegador navegamos a: http://localhost:1337 y http://localhost:1337/api/contrato para verificar que este nuestro home y API funcionales. Si hay errores de sintaxis se reportaran en la consola.

####Parte 2 - Configuracion de UI

notas:

• Todos los comandos son desde la raiz de nuestro projecto (contratobook/{tunombre})
• Se asume que el app esta ejecutandose ya sea con sails lift o alguna otra herramienta como nodemon o forever
• Cuando se hacen cambios en el backend api/ config/ se tiene que re-iniciar el servidor para que se ejecute el nuevo código

###Instalar librerias de cliente

• Inicializar bower con bower init. Dar enter (respuesta default) a todas las preguntas que hace bower.

• Crear un archivo .bowerrc en la raiz de nuestro proyecto. Adentro de este archivo colocar el sig. código:

 {
   "directory": "assets/bower_components"
 }

• Instalar angular-material; instalara otras dependencias como angular, bower install --save angular-material

• Hammer.js es requerido por angular-material pero no esta incluido en el paquete bower install --save hammer.js

• Angular route 'bower intall --save angular-route'

###Importar Librerias de Cliente

El archivo pipeline define cuales son las librerias que son importadas a nuestro template maestro views/layout.ejs

• En tasks/pipeline modificar las siguientes variables para que incluyan las librerias que queremos:

var cssFilesToInject = [
  'bower_components/angular-material/angular-material.css',
  'styles/**/*.css'
];

var jsFilesToInject = [
  'js/dependencies/sails.io.js',
  'bower_components/angular/angular.min.js',
  'bower_components/angular-route/angular-route.min.js',
  'bower_components/hammer.js/hammer.min.js',
  'bower_components/angular-aria/angular-aria.min.js',
  'bower_components/angular-animate/angular-animate.min.js',
  'bower_components/angular-material/angular-material.min.js',
  'js/**/*.js'
];

• Re-iniciar servidor y verificar en archivo views/layout.ejs si estan importados nuestros scipts

###Configurar Layout

###Tips:

####Instalacion de sails y bower

npm -g install sails npm -g insall bower

####Nodemon

Nodejs funciona como un servidor independiente, es decir cada app es un server. Usar nodemon o forever para manter el servidor ejecutandose y para que se reinicie automaticamente cuando hay cambios en el codigo del backend es una buena practcica.

Ej:

nodemon -w api -w config

####NPM Si sails new no te funciona despues de instalar sails intenta desintalar node e instalarlo via el metodo recomendado oficialmente: https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager#debian-and-ubuntu-based-linux-distributions

####Terminator Puedes usar terminator para tener dos consolas visibles; una con el app ejecutandose y la otra libre para hacer otros comandos. Con ctrl+e agregas un panel horizontalmente y con ctrl+w lo cierras